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.
> * Generally, in my index I include acronyms with a "see _insert
> acronym meaning here_" and no page number. The corresponding
> entry includes all of the information.
> Occasionally, however, the acronym is more important that the
> terms for which it stands.
> Would it be acceptable to consistently mix my standards?
Paul,
We face this same problem at CMS. The radiation treatment planning
(RTP) field utilizes many acronyms, most of which are more
recognizable than the spelled-out form. We opted for consistency,
however, and index the terms as you described in the first paragraph.
If you are consistent throughout, your readers should have no trouble
finding what they need. (We have never had a complaint about our
indexing scheme.)
Robbie Rupel
Senior Technical Writer
Computerized Medical Systems, Inc.
St. Louis, Missouri
robbie -at- cms-stl -dot- com
