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: Index entries for glossary terms From:Sue Ahrenhold <sahrenho -at- ARBORTEXT -dot- COM> Date:Fri, 9 Jul 1999 11:18:36 -0400
It sort of depends on what kind of an index it is.
If you are doing a paper back-of-book index, you probably can save the
If you are doing an online help system, and you want to provide access to
the glossary definitions, an index entry could save your users a lot of time.
But whatever you do, do it consistently. If you index glossary terms, index
them all. If you index functions, index them all. I am a firm believer in
indexing for the regular user, (s)he should be able to infer the rules you
used to design the index from regular use of the index; as in, "No, just
look in the glossary right before the index. Glossary definitions aren't
included in the index. But if you want to see an example, the index will
tell you the correct page."