[Date Prev][Date Next]
[Thread Prev][Thread Next]
[Date Index]
[Thread Index]
[New search]
Subject: Re: Opinions Please !
From: lsmalley@xxxxxxxxxxxxxxxx (Lester C. Smalley)
Date: Thu, 8 Apr 1999 13:08:11 -0400
Cc: framers@xxxxxxxxxxxxxx, framers@xxxxxxxxx
Sender: owner-framers@xxxxxxxxx
= ********************************************
= You can usually base a good
= starting index on the text of
= your headings, subheadings,
= titles, and so on.
= ********************************************
=
= Richard Melanson
= Technical Writer
= Exchange Applications
= 617-737-2244
= rmelanson@exapps.com
Well (to paraphrase BillC) it depends on what the the meaning of 'good
starting index' is.
Lacking any other guideline, and not knowing the nature of the material,
sure, this is probably an acceptable starting point. However, there is
_no way_ the reuslt of the above should be considered the final index.
A good index will also at the very least include references to all the
places that 'key concepts' are used, and especially defined, in the doc.
Also, you should include index entries that try, as much as possible, to
use the 'unitiated readers' terminology, not merely the words/phrases in
the document itself. (take for example, look at the FM User Guide index;
how often have you been frustrated trying to find something that is "not"
is the index, at least, not in the terminology _you_ expect)
And of course, there is the issue of permuted/alternate entries - not
only the
string() function 46, 51-52, 177
but
functions
...
string() 46, 51-52, 177
to contend with.
Some references (culled from _many_ previous posts to 'framers' on
the subject from the likes of Hedley Finger and Conrad Taylor among
others) you may want to check out:
Bonura, Larry, _The Art of Indexing_,
Wiley Technical Communication Library series,
John Wiley, New York, 1994
This is a how-to which assumes you will be using 3x5 index cards.
Wellisch, Hans H., _Indexing from A to Z_,
H.W. Wilson, New York, 1991
This consists of a series of articles in alphabetical order
of title which is not for the first-timer but ultimately
essential once you have mastered the previous book.
Knight, G[ilfil]. Norman, _Indexing, the Art of_,
Allen & Unwin, London, 1979
Now well out-of-date as it was published before the widespread
advent of word-processors, this is a comprehensive introduction.
Unfortunately out of print and unlikely to be revised and re-
issued now that the author is dead and whoever bought the
copyright from the defunct Allen & Unwin did not realize what
a treasure they have. Look for in secondhand book shops.
Mulvaney, Nancy C., _Indexing Books_
University of Chicago Press
ISBN: 0-226-55014-1 hardback
320 pp ... including index, of course
Also, visit the American Society of Indexers at:
http://www.well.com/user/asi/index.html
http://www.asindexing.org/software.htm
or
http://asindexing.org/indfaq.htm
- Lester
----------------------------------------------------------------------
Lester C. Smalley | email: lsmalley@infocon.com
Manager, Computer Systems & Training | USMail: P. O. Box 310
Information Consultants, Inc. | Phone: (302) 239-2942 ext-13
Hockessin, DE 19707-0310 | FAX: (302) 239-1712
--------------------------------------+-------------------------------
INFOCON is a Premium VAR for Adobe, Sun, and related hardware/software
dedicated to providing integrated office solutions for productivity.
----------------------------------------------------------------------
http://www.infocon.com/
** To unsubscribe, send a message to majordomo@omsys.com **
** with "unsubscribe framers" (no quotes) in the body. **