RE: Acronyms in documentation (was RE: Need some help for SRS

["John Posada" <JPosada -at- isogon -dot- com>]

>That was always my practice in paper and 
>PDF docs, but what's "best practice" in 
>Help? 

If the online help has a Glossary tab, I place the acronyms in there. 

Lacking that, I place the acronym in the Index and link the Index
element to a topic where it is defined.

Lacking that, I don't worry about it because if the help doesn't have a
Glossary or Index, the user has bigger problems with the help than what
the acronym means.
 
John Posada
Senior Technical Writer
Isogon Corporation
http://www.isogon.com 
  "Realizing Your Business Goals 
   Through Software Asset Management"
 

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

ROBOHELP X5 - ALL NEW VERSION. Now with Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more!

Now is the best time to buy - special end of month promos, including:
$100 mail-in rebate; Free online orientation on content management
functionality; Huge savings on support and future product releases;
PLUS Great discounts on RoboHelp training. OFFER EXPIRES April 30th!
Call 1-800-358-9370 or visit: http://www.ehelp.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit
http://www.raycomm.com/techwhirl/ for more resources and info.