Re: When to Spell Out Acronyms
Harris, Michael wrote:documentation is determining
One of the most fluid issues I find in writing technical
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 itout is not necessary.
The standard for the government documents I write (for the Navy) is to
spell out the acronym the first time it appears, no matter how common
the acronym (or abbreviation) is. PC? Spell it out. DoD? Spell it out.
One thing that can get annoying with spelling it out the first time is
when large swaths of content get moved around. What used to be the
first instance may no longer be the first instance. It'd be nice if
there was a tool out there that would automatically spell out the
first instance for me....
We also include a table at the end with all of the acronyms in the
document included, in case someone comes into the document after the
acronym has been spelled out, and needs to know what it stands for.
thejavaguy -at- gmail -dot- com
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.
- Re: When to Spell Out Acronyms, Al Geist
Previous by Author:
Re: Customizing Help
Next by Author: Re: Where's the beginning? (was RE: When to Spell Out Acronyms)
Previous by Thread: Re: When to Spell Out Acronyms
Next by Thread: Re: When to Spell Out Acronyms
Search our Technical Writing Archives & Magazine