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.
Paul -- If there are just a few page references, the best solution is to
provide page refs after *both* the acronym (with spelled-out term in
parentheses) and the spelled-out term (with acronym in parentheses). For
example:
However, if you have several subentries, you should put them under the
whichever is the better-known term. For example, if your audience would
be more familiar with "SNMP" than with "Simple Network Management
Protocol," then the subentries should be under "SNMP (Simple Network
Management Protocol" and you should provide a *See* reference for the
spelled-out version:
SNMP (Simple Network Management Protocol)
first subentry
second subentry
third subentry
zee last subentry :-)
On the other hand, if your audience is *not* likely to be familiar with
either the acronym (example: "VB") or the spelled-out version ("View
Builder") and, if we can assume that there are several subentries for
that topic, you should put the subentries under the spelled-out version:
VB
*See* View Builder
and
View Builder (VB)
first subentry
second subentry
third subentry
*See* references point readers to the *preferred* term. When you index
terms in this way, your index becomes a learning tool for readers who may
not be familiar with product terminology.
Hope this helps ....
Lori Lathrop
************************************************************************
Lori Lathrop ----------> INTERNET:76620 -dot- 456 -at- compuserve -dot- com
Lathrop Media Services, P.O. Box 808, Georgetown, CO 80444
************************************************************************