My TECHWR-L | Articles | Community | About TECHWR-L

[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: When to Spell Out Acronyms

Subject: Re: When to Spell Out Acronyms
From: Al Geist <al -dot- geist -at- geistassociates -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 21 Nov 2006 09:01:41 -0500

Harris, Michael wrote:

One of the most fluid issues I find in writing technical documentation is determining when to spell out acronyms in the first usage and when to 'assume' that since all of the readers should have some knowledge of the material, that spelling it out is not necessary.
Does anyone have guidance in this regard? The primary customer of our documentation is a technical branch of the Army. While CPU is well known, does it get spelled out? How about CORBA, which a local manager thinks is well-known enough as Common Object Request Broker Architecture and does not need to be spelled out.




I've found that when you assume everyone knows what you're talking about that just the opposite may be true. I spell out the first instance regardless. For example, COBRA may mean one thing to the Army, but it means another to someone in HR (where COBRA is an insurance option for the recently unemployed). PCP for a project I am currently documenting, it means Process Control Program. For those in the medical industry, it is an abbreviation for an an anesthetic. CPU in the computer industry means Central Processing Unit. It can also mean Change Password Utility, or (according to Google) the Canadian Powerlifting Union.


The key is knowing your audience. Then again, if you define every military acronym, you may never get to the meat of a document.

Al "who once defined an military acronym that was 20 words of a 25 word sentence"



--

Al Geist
Technical Writing, Online Help, Marketing Collateral, Web Design, Award Winning Videos, Professional Photography
Voice/Msg: 802-658-3140

Cell: 802-578-3964
E-mail: al -dot- geist -at- geistassociates -dot- com <mailto:al -dot- geist -at- geistassociates -dot- com>
URL: www.geistassociates.com <http://www.geistassociates.com> (online portfolio/resume)

See also:
URL: www.geistimages.com <http://www.geistimages.com> (fine art prints for home for office, and note cards for all occasions)

"When they call the roll in the Senate, the Senators do not know whether to answer "Present" or "Not guilty.""
Theodore Roosevelt


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.

Follow-Ups:

References:
When to Spell Out Acronyms: From: Harris, Michael

Previous by Author: Re: Procedures for supposedly obvious things
Next by Author: Re: When to Spell Out Acronyms
Previous by Thread: When to Spell Out Acronyms
Next by Thread: Re: When to Spell Out Acronyms

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]