TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: To Index of not to Index From:keilanhoo -at- yahoo -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 4 May 2004 09:01:10 -0600
My default answer to this is to index everything. Users don't necessarily
think about how to find information in the order used in the TOC. An index
can be more point-specific, which is generally how people think, so many
times an index is more useful than a TOC in finding the information needed
at the moment.
For example, a man repairing a car who is about to replace the cylinder
head needs to look up the torque wrench settings. He doesn't think,
"Repairs > Engine > Cylinder Head > Replacing > Tools Required > Torque
Wrench > Settings," but that is sort of how most TOCs would be arranged.
He doesn't think in terms of work flow, but of a point need. He thinks,
"Torque wrench > settings" or perhaps "Settings > Torque wrench."
_However_
Because doing good indexes can be so time-consuming, and you'd be doing
them after the fact, you need to consider if there is a real need in your
particular situation. Adding indexes to existing documents may be a nice
idea on the face of it, but it's a waste of time unless the company will
release the updated documentation to the customers. And doubtless your
boss would not want you to spend a lot of time indexing an old document if
that would take time away from working on something new. I would suggest
indexing all new docs, but don't bother adding to old docs unless you know
they'll be redeployed.
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more. http://www.doctohelp.com
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
