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:"David M. Brown" <dmbrown -at- BROWN-INC -dot- COM> Date:Fri, 9 Jul 1999 08:20:59 -0700
"Brierley, Sean" wrote:
>
> If a glossary term is minor and has no major significance,
> then I do not index it. ...
>
> If a glossary term is important to a topic of great importance ...
> I would index it ...
I prefer to offer the consistency of indexing all the terms--and in hypertext, it's not a matter of saving paper or limiting page count.
I also include "glossary" and "definitions" as index entries. Depending on the delivery format, these may display all terms (in the Topics Found dialog box) or simply link to the top of the glossary.
>
> Typically, indices take me several days to plan and create; they are not a
> light task. Also, I can expect that reviewers and SMEs skip the index, even
> though I specifically ask for a review of it.
I suppose we've been lucky, in that most of our clients allow plenty of time for indexing. On a particularly large help file for a very complicated application, we've had as much as three weeks between "end of writing" and "hand over to manufacturing" to get the index drafted and reviewed.
--David
=============================
David M. Brown - Brown Inc.
dmbrown -at- brown-inc -dot- com
=============================