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:Re: When to Spell Out Acronyms From:"Melissa Nelson" <melmis36 -at- hotmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 21 Nov 2006 10:01:46 -0500
I also do military documentation and I place the acronym table at the
beginning of the document and still have to spell it out the first time it
is used, no matter how common it is...the rational being that the reader
will not want to go back to the table to find the meaning of it. But the
table still has to be there...
Military documentation has a set of rules all its own sometimes..and they do
not need to make sense. Once I learned that, my job became a lot easier. :)
From: Al Geist <al -dot- geist -at- geistassociates -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: When to Spell Out Acronyms
Date: Tue, 21 Nov 2006 09:21:20 -0500
>
> David Castro wrote:
>
> 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.
> 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.
>
> If you place the table at the beginning of the document, then
wouldn't that
> satisfy the criteria of spelling it out the first time it
appears? If so,
> that would save you the time rearranging when your former first
instance it
> not longer the first instance because of revisions....phew...need a
cup of
> coffee after that last sentence.
> Al
>
> --
>
> 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: [1]al -dot- geist -at- geistassociates -dot- com
> URL: [2]www.geistassociates.com (online portfolio/resume)
>
> See also:
> URL: [3]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
>
>References
>
> 1. mailto:al -dot- geist -at- geistassociates -dot- com
> 2. http://www.geistassociates.com/
> 3. http://www.geistimages.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 melmis36 -at- hotmail -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/melmis36%40hotmail.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.
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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