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: Is a bad index better than no index? From:Susan Ahrenhold <sahrenhold -at- winspc -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 23 May 2001 10:53:28 -0400
My $.10 -- surcharge for experience --
I agree with Geoff that one of the most important things a human adds to an
index is synonyms. And, try thinking like your target audience.
If you are publishing "documents," but at least two depts in your company
calls them "reports," be sure you have at least a cross-reference between
the two terms. Try to know the vocabulary of your industry. If your software
calls a particular feature "searching," but most companies call the same
function "finding," be sure that you create a cross-reference from "finding"
to "searching." Good indexing like this makes switching from a competitor's
product to your product just that much easier.
And one more pet peeve. Make sure that all pages in the book are in the
index. If you bind two books in one, either color-code the index pages, so
that people can find them (think bleeding-edge color), or make a shared
index. Or was I the only one who could never find anything in the multi-book
DOS docs that Microsoft used to release, when they still did paper?
>>>Oh, and I was a liBRARian???!!! too! Unfortunately, people seem to think
>>>that's quite in keeping with my personality. What can I say?? In any
event,
>>>it was good training for many aspects of being a technical writer.
Another librarian in a previous life here. Actually, the organizational
skills inherent in library science are very valuable in all branches of
technical writing. We are trained to look for structure.
I am also a freelance indexer. This allows me to read books on interesting
new topics on a regular basis, and keeps my indexing skills sharp.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -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.