Re: abbreviations, acronyms, and glossaries

[Mc Jdub <wigginje -at- PSSCH -dot- PS -dot- GE -dot- COM>]

> If an accronym or abbreviation exists for a name, then I spell it out
> the first
      few times, then use the short form

I general, my recommendation would be to provide the acronym or
abbreviation parenthetically after you first cite the
whatever-it-happens-to-be (WIHTB), and then continue to use the short
form from that point forward. This, rather than spelling-out the first
"few" times, will lead to the greatest consistency among your range of
documents.

A glossary can certainly be useful if you have an inordinate number of
acronymns or abbrevs. An index, too, can help the reader locate the
first instance of the spelled-out WIHTB. (Don't forget to
cross-reference.)

As always, it is important to question what is suitable and appropriate
for your particular audience.

VTY,
Jeff Wiggin
wigginje -at- pssch -dot- ps -dot- ge -dot- com

> ----------
> From:
> John -dot- Cornellier -at- PARIS -dot- IE -dot- PHILIPS -dot- COM[SMTP:John -dot- Cornellier -at- PARIS -dot- IE -dot- PHI
> LIPS.COM]
> Sent:         Wednesday, July 09, 1997 8:26 AM
> To:   TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject:      abbreviations, acronyms, and glossaries
>
> 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
>  Send list questions or problems to the listowner at
>

 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