🚀 go-pugleaf

RetroBBS NetNews Server

Inspired by RockSolid Light RIP Retro Guy

Article View: misc.writing
Article #1333

Re: Indexing (was: *** Why is rewriting bad?)

#1333
From: Thomas Beagle
Date: Mon, 25 Jan 1993 19:27
34 lines
2006 bytes
In article <1993Jan22.210427.2947@sqwest.wimsey.bc.ca> marcy@sqwest.wimsey.bc.ca (Marcy Thompson) writes:
>>In article Thomas Beagle writes:
>>
>>|> ObWriting : When writing a manual, do you index as you go (and risk
>>|> all sorts of incompatibilities) or do you index after the bulk of the
>>|> manual is written?
>
>As we go. We use SGML and our document structure includes index elements.
>You can put them in as you go. ("Oh, I'm writing about error messages. That
>should go into the index. BANG! There it is.")

I use software with similar capabilities to yours. (Word offers index
headings and hidden tags within the main document.)

But when indexing as you go, how do you ensure that the index will be
internally consistent?

For example, if you're talking about function keys, you might get into
the trap of indexing under function keys for half of them, and under
the individual commands for the other half. (Bad example but you get
the idea.)

Or do you catch this at the editing stage?

>I've worked in shops where the indexing was done by hand at the end of the
>process. This is much, much better. Much better. 

I can't help thinking that indexing by hand should be banned under the
Geneva Convention. :-)

-- 
    Thomas Beagle | thomas@datamark.co.nz           Work: 64 4 233 8186
 Technical Writer | thomas@cavebbs.welly.gen.nz     Home: 64 4 499 3832
   Wellington, NZ | Yes, I do have long ears, a black nose, and a tail.
Technical Details
Message-ID: <1993Jan25.192738.51901@datamark.co.nz>
Path: arc1-ca.pugleaf.net!sparky!uunet!ogicse!decwrl!waikato.ac.nz!comp.vuw.ac.nz!ferrari.datamark.co.nz!thomas
References: <1993Jan21.203546.45088@datamark.co.nz> <C19EqC.6s5@unx.sas.com> <1993Jan22.210427.2947@sqwest.wimsey.bc.ca>

Show Full Headers
Complete Article Headers
Path: arc1-ca.pugleaf.net!sparky!uunet!ogicse!decwrl!waikato.ac.nz!comp.vuw.ac.nz!ferrari.datamark.co.nz!thomas
From: thomas@datamark.co.nz (Thomas Beagle)
Newsgroups: misc.writing
Subject: Re: Indexing (was: *** Why is rewriting bad?)
Message-ID: <1993Jan25.192738.51901@datamark.co.nz>
Date: 25 Jan 93 19:27:38 GMT
Article-I.D.: datamark.1993Jan25.192738.51901
References: <1993Jan21.203546.45088@datamark.co.nz> <C19EqC.6s5@unx.sas.com> <1993Jan22.210427.2947@sqwest.wimsey.bc.ca>
Organization: Datamark International Ltd.
Lines: 34