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:abbreviations, acronyms, and glossaries From:John -dot- Cornellier -at- PARIS -dot- IE -dot- PHILIPS -dot- COM Date:Wed, 9 Jul 1997 14:26:42 +0200
When to use acronyms & abbreviations, and when to write out in full? Any general
guidelines?
Since my productivity isn't measured by the thickness of my manuals, I like to
be brief. I understand that one of the criteria for reading ease is average
word-length.
If an accronym or abbreviation exists for a name, then I spell it out the first
few times, then use the short form. (I'm talking about paper manuals here -
Winhelp has those nice little glossary popups).
Is it ever better to spell out in full? Maybe when there are too many new terms
and the user's brain runs out of EEPROM (memory)?
Explanations could be put in a glossary, but is there any evidence that people
read glossaries? I guess footnotes are no longer appropriate outside acedemia?
John -dot- Cornellier -at- paris -dot- ie -dot- philips -dot- com
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
