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:an indexing question From:Stuart Burnfield <slb -at- FS -dot- COM -dot- AU> Date:Mon, 15 Jun 1998 14:03:39 +0800
It's hard to certain without knowing the real characteristics in your
database, but a general attribute such as 'colour' doesn't seem like
a useful search path. Readers aren't likely to look up the index
knowing that they're interested in a red thing, but not knowing what
the thing itself is. They're also not likely to be interested in
seeing grouped together all red things or all colourful things.
They *are* likely to want to see the main attributes of an object
grouped together, especially if the references are scattered through
the book:
Dingus
colour 17, 20
texture 18, 92
replacing 65
If all the references are tightly clustered, there's no need to be
excessively detailed. Remember that the purpose of the index is not to
do away with the book, it's to steer the reader quickly toward the
right place in the book. Avoid this sort of thing:
If I'm telling a taxi driver where I want to go, I don't tell them how
to find my front door while we're still at the airport. I just want to
get us first to the right general area, then when we get close I can say
"Left here, right at the lights, I live under that bridge over there."
Regards
---
Stuart Burnfield "Some wear their heart on their sleeve
Functional Software Some wear the patience of saints mailto:slb -at- fs -dot- com -dot- au Some wear the weight of the world on their shoulders"
-- Deborah Conway 'String of Pearls'