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:Donald Le Vie <dlevie -at- VLINE -dot- NET> Date:Fri, 9 Jul 1999 10:00:18 -0500
At my last place of employment, my last big index project took 3 weeks to
hand-generate entries in addition to the auto-generated ones, test the
integrity of those entries, check the proper nesting of all the related
references, and format the index for a 350-page microprocessor reference
manual. My previous employer relied exclusively on autogenerated lists of
index-tagged text, which was usually done by SMEs (gag!), if they did it at
all! Prior to my working for them, there were no documentation quality
benchmarks or controls whatsover. A 500-page technical manual might have a 3
or 4 page autogenerated index, and if you wanted to really build a
comprehensive index, there wasn't any time in the schedule to do so.
Donn Le Vie
Integrated Concepts
> -----Original Message-----
> From: Kim Nylander [SMTP:nylanderk -at- IPIX -dot- COM]
> Sent: Friday, July 09, 1999 9:54 AM
> To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject: Re: Index entries for glossary terms
>
> On 7/9/1999 10:31 AM, Ann Howell said:
>
> >I'm in the process of creating my first big(-ish) index and I now see why
> >index
> >writing is a vocation of its own. One quesiton: should I be creating
> >entries for
> >terms that appear in the glossary (the glossary directly precedes the
> >index), or is that redundant?
>
> I am also in the middle of indexing a large document under a tight
> deadline. It's a very complex project, so I am trying to create a very
> thorough index. I tend to create index entries for terms in the
> glossary. I list the term, say "image," and then underneath it say
> "Definition" and list the glossary page.
>
> I'm curious to see if anyone else has any tips on creating index entries,
> and what plans (if any) are used for indexing.
>
> Regards,
>
> Kim Nylander
>
> Technical Writer
> Interactive Pictures
> Oak Ridge, TN 37830
> (423) 482-3000
>
>
> From ??? -at- ??? Sun Jan 00 00:00:00 0000=
> =
>
