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: Testing an index From:J Wermont <jwermont -at- sonic -dot- net> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Sat, 23 Feb 2008 16:17:16 -0800
Peter Neilson wrote:
> Sandy Harris is of course correct - usefulness of an index comes from
> being able to find the entry you're looking for and not from
> consistency. The terms appearing as entries (and even their spellings)
> do not necessarily have to match, in every instance, what is found in
> the book.
I wonder, though, if the term the user is searching for doesn't match
the terminology used in the book, but is more or less synonymous such that
you would put the user's term in the index, wouldn't the user be looking
for his/her own term in the text? What would alert the user that the word
"bar", used in the text, actually means the same thing as the word "foo",
which he or she was looking for? Wouldn't the user be scratching his/her
head, thinking "What's all this about 'bar'? And where's the stuff about
'foo', as the index said would be on this page?"
> If you are using software that automatically prepares your index from
> the book's pagination, off-by-one errors may appear. The entry pointing
> you to page 763 should actually have suggested 762 or 764.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-