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:"Sharon Burton" <sharon -at- anthrobytes -dot- com> To:"Fred Ridder" <docudoc -at- hotmail -dot- com>, "Peter Neilson" <neilson -at- windstream -dot- net>, "Wanda Phillips" <wanda -dot- jane -at- gmail -dot- com> Date:Sat, 23 Feb 2008 07:42:13 -0800
See Also keywords can be useful for teaching your users about vocabulary,
too - for example, you know that your users may know several other products
like yours. So they come to your product with the vocabulary of the
Indexing that vocab with See Alsos to your vocab can help your users learn
that Bob is called Sue in your product. Just giving them Bob 145 may confuse
them when they go to page 145 and can't find Bob, because it's called Sue
and they don't know that.
Responding to Wanda Phillips, Peter Neilson wrote (in part):
> Although entries that tell the reader to "See also" are occasionally
> helpful, the entry that says, "See" rarely is. "Baked beans, see Beans,
> baked" could have just as easily said, "Baked beans, 162."
And then Fred Ridder goes...
Where "See..." entries *are* useful is to identify a more fundamental
difference in terminology or to offer a close alternative.
To continue with Peter's example, your cookbook index might include
an entry "Boston baked beans, see Beans, baked" or "Cassoulet, see
Beans, baked" if there is some discussion of baked bean dishes that
mentions those specific preparations without actually giving recipes.
In this case, the "see" entry provides a clue that the reference is
not an exact match for the topic the reader is looking for.
Or your cookbook index might include an entry like "Legumes, see
Beans" if all your entries for legume recipes are indexed as bean
recipes. This is most appropriate where there are multiple entries
that use the different term you identify so that you really couldn't
pick just one to topic (recipe, in this case) to point to directly.
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-