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:Acronyms in Glossary From:JLORENZE -at- JCPENNEY -dot- COM Date:Tue, 28 Mar 1995 17:29:14 CST
To TECHWR-L--INET
From: Jane Lorenzen
I'm working on a large on-line procedures manual for our
inventory analysts. My questions are about where to put
acronyms in the glossary.
The first question is whether we should list entries in the
glossary under the acronym/initialism/abbreviation, followed by
the spelled-out version:
> CSR (Customer Service Representative)
or as the fully spelled-out term, with the acronym in parentheses:
> Customer Service Representative (CSR).
Each letter of the alphabet has its own screen in the glossary;
for example, the user clicks on a "B" button to go to a list of
words that start with the letter "B," then clicks on the term.
Each letter's list is pretty short (you can see most, if not all,
of the terms on one screen without scrolling), so "both" probably
wouldn't be necessary.
My second question: if we decide to list them by
acronym/initialism instead of by the full term, how do we sort
them within the glossary? Right now they're listed like this:
I find this arrangement a bit disorienting. "FSUB" just doesn't
"belong" ahead of "Factory Ship" in my model of the world.
My references are silent about the issue. I guess they weren't
written by people who work in an environment where people
actually speak in acronyms instead of complete words (never mind
complete sentences).
Thanks for any enlightenment y'all can provide.
+---------------------------------------------------------------------------+
|/\/\/\/\/\/\/\/| Jane Lorenzen |\/\/\/\/\/\/\/\|
| Telephone: | Online Training & Reference | Fax: |
| 214-431-3061 | Catalog Merchandising | 214-431-8848 |
|\/\/\/\/\/\/\/\| JLORENZE -at- jcpenney -dot- com |/\/\/\/\/\/\/\/|
+---------------------------------------------------------------------------+
Forrest Gump: "Sometimes there just aren't enough Oscars."