Advertising Age reports yesterday that 20 MINUTES is “the average amount of time a consumer spends trying to set up a device before giving up”. Figure out how many returns or support calls that generates for your company, and figure out how much those returns or support calls cost your company, and you have your business case for better documentation!
Katriel
IMHO, the Word 2007 ribbon interface is a big improvement. However, it takes time to get your bearings. (I’ve been using Word 2007 full-time for about 9 months, since the beta period, and I still find myself scratching my head trying to remember where to find a particular function that I could find in my sleep in earlier versions.)
So — you may want to check out the Get Started tab (shown below). Download from the Microsoft site.
You can also download a workbook from the Microsoft site that lists the locations of Word 2003 commands in Word 2007. Recommended!
Katriel
A.S., a loyal reader, writes, “I’m a bit hazy on the difference between XML and XSD”. Well, hopefully this post will clarify the issue for you.A schema (XSD) describes what must be in the XML document. For example, it might say that every item must have one catalog number, and one name, but may have one or more sizes (e.g. 500 gram and 750 gram).
The schema (XSD) describes what must be in the XML document. For example, it might say that every item must have one catalog number, and one name, but may have one or more sizes (e.g. 500 gram and 750 gram).
The XML document would list what’s in the catalog. For example:
100
Corn Flakes
500
700
200
Bran Flakes
500
750
1000
1250
In the above case, the schema (XSD) would declare the XML file invalid if it had no catalog number – or if it had 2 or more catalog numbers.
Katriel
BTW, DITA processors generally use DTDs rather than XSDs, but that’s another post.
Word 2007 creates, by default, ”.docx” files rather than “.doc files”. If you need to share .docx files with users of earlier versions of Word, you can save as .doc files. If you do not have Word 2007 but have received .docx files — no need to worry. Just download the compatibility pack from Microsoft — allows older versions of Word to open .docx files.
When saving as .doc files Word will warn you about any features that are likely to be problematic. In my experience to date, Word has been conservative — warning about relatively minor problems.
Katriel
Avi, a loyal and critical reader, asks “I already have a suitable tool (RHX5), what could I possibly benefit from… ”
Well, Robo Help is certainly a reputable tool. And, if it works for you, then remember the first rule from Engineering 101: “If it works don’t fix it”.
But if you need to deliver content in multiple channels (PDF), if you need to tailor content for specific audiences, if you want to reuse content for different needs (implementation, training, user guide, troubleshooting, support, etc.), if you need to cut down on translation costs… then IMHO you should be thinking seriously about DITA.
Katriel
P.S. We have posted a new white paper: Find out why DITA matters and what’s in it for you.
The greatest enemy of a great technical writer solution is the dream of a perfect solution.
Is DITA perfect? No. Is it as easy as just writing without thinking about structure, just as we might in Word or FrameMaker or an HTML editor? No. Do writers need to learn how to think in topics and use a DITA editor? Of course. Is there friction in the move to DITA? Absolutely.
This being said, we should paraphrase Winston Churchill: “It has been said that DITA is the worst approach to technical documentation except all the others that have been tried.” Go for it - we technical communicators have nothing to fear but inaction!
Katriel
In the engineering world the need for standards, and for standards compliance, is almost universally accepted. Standards foster efficiencies and synergies.
In the technical document world, however, there is an almost inexplicable resistance to standards. Each company makes their own style guide and templates. And getting tech writers to voluntarily accept DITA? Hoo, hoo. Takes considerable persuasive powers (as well as management carrots and sticks).
Let’s try and understand why this is the case by looking at Pete, a typical manager. Pete could make no changes and continue working tomorrow using the same tools and methods (typically authoring in Word, FrameMaker, and/or using WebWorks to convert to Help, and/or editing content in RoboHelp). Ideally they would be using a good template and toolkit, such as Author Max.
No change is easy. No need to convince management, no need to battle for a budget, no need to train writers, no disruption.
If Pete decides to go for DITA, he’ll have to do all of the above. Persuade management, get a budget, train writers and figure out how to manage the transition. Not easy. And, if the transition is not smooth, Pete could be penalized.
On the other hand, Pete could get through the transition period to DITA and leverage the same team that he had yesterday to produce more documents, more focused documents, better documents. Is there risk in the transition? Of course, but that’s what life is about - adapt or disappear.
I’m just old enough to remember those dinosaurs at the end of the 80s early 90s who were still using white-out, typewriters and cut and paste — because they didn’t go for transition in time. You know what, I haven’t met any of those dinosaurs anywhere in the last 15 or 20 years, certainly not on the upwardly mobile, happily-employed career track.
So, Pete, what will it be?
Katriel
P.S. The participants in this month’s DITA Immersion Workshop, and last month’s, and the one before… are voting with their time. Finding out about DITA and empowering themselves to make informed decisions.
