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: Testing an index From:Peter Neilson <neilson -at- windstream -dot- net> To:Wanda Phillips <wanda -dot- jane -at- gmail -dot- com> Date:Sat, 23 Feb 2008 00:50:22 -0500
Sandy Harris is of course correct - usefulness of an index comes from
being able to find the entry you're looking for and not from
consistency. The terms appearing as entries (and even their spellings)
do not necessarily have to match, in every instance, what is found in
If you are using software that automatically prepares your index from
the book's pagination, off-by-one errors may appear. The entry pointing
you to page 763 should actually have suggested 762 or 764. Fix these
errors in whatever way you can. Try to avoid post-editing.
Look at a known good index for inspiration. Personally I like to study
indexes in cookbooks. Notice Rombauer and Becker's use of "About" in
entries such as "Beans, About". Notice how nearly all cookbooks use only
two levels of indexing. You may find these entries:
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-