home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1993 #3 / NN_1993_3.iso / spool / misc / writing / 4264 < prev    next >
Encoding:
Internet Message Format  |  1993-01-25  |  1.9 KB
  1. Path: sparky!uunet!ogicse!decwrl!waikato.ac.nz!comp.vuw.ac.nz!ferrari.datamark.co.nz!thomas
  2. From: thomas@datamark.co.nz (Thomas Beagle)
  3. Newsgroups: misc.writing
  4. Subject: Re: Indexing (was: *** Why is rewriting bad?)
  5. Message-ID: <1993Jan25.192738.51901@datamark.co.nz>
  6. Date: 25 Jan 93 19:27:38 GMT
  7. Article-I.D.: datamark.1993Jan25.192738.51901
  8. References: <1993Jan21.203546.45088@datamark.co.nz> <C19EqC.6s5@unx.sas.com> <1993Jan22.210427.2947@sqwest.wimsey.bc.ca>
  9. Organization: Datamark International Ltd.
  10. Lines: 34
  11.  
  12. In article <1993Jan22.210427.2947@sqwest.wimsey.bc.ca> marcy@sqwest.wimsey.bc.ca (Marcy Thompson) writes:
  13. >>In article Thomas Beagle writes:
  14. >>
  15. >>|> ObWriting : When writing a manual, do you index as you go (and risk
  16. >>|> all sorts of incompatibilities) or do you index after the bulk of the
  17. >>|> manual is written?
  18. >
  19. >As we go. We use SGML and our document structure includes index elements.
  20. >You can put them in as you go. ("Oh, I'm writing about error messages. That
  21. >should go into the index. BANG! There it is.")
  22.  
  23. I use software with similar capabilities to yours. (Word offers index
  24. headings and hidden tags within the main document.)
  25.  
  26. But when indexing as you go, how do you ensure that the index will be
  27. internally consistent?
  28.  
  29. For example, if you're talking about function keys, you might get into
  30. the trap of indexing under function keys for half of them, and under
  31. the individual commands for the other half. (Bad example but you get
  32. the idea.)
  33.  
  34. Or do you catch this at the editing stage?
  35.  
  36. >I've worked in shops where the indexing was done by hand at the end of the
  37. >process. This is much, much better. Much better. 
  38.  
  39. I can't help thinking that indexing by hand should be banned under the
  40. Geneva Convention. :-)
  41.  
  42. -- 
  43.     Thomas Beagle | thomas@datamark.co.nz           Work: 64 4 233 8186
  44.  Technical Writer | thomas@cavebbs.welly.gen.nz     Home: 64 4 499 3832
  45.    Wellington, NZ | Yes, I do have long ears, a black nose, and a tail.
  46.