RE: Acronyms in documentation?

Subject: RE: Acronyms in documentation?
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: 28 Apr 2004 16:35:15 GMT


When I did my first online help, this was the approach
I tried in the first draft, but the feedback from our
more experienced users was that having to read the same
definition over and over again was annoying. Since then,
what I have preferred is to make the first instance in
each topic a jump to the definition in the glossary, so
that users who don't know what an acronym or abbreviation
means can easily look it up while those who do can just
move on.

Gene Kim-Eng

------- Original Message -------
On Wed, 28 Apr 2004 12:14:05 -0400 Geoff Hart wrote:

For each document (here, a help topic rather than the
entire help system), redefine the acronym as soon as it appears. This redundancy takes up insignificant amounts
of space, and the payback in usability can be tremendous.

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

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.



Previous by Author: RE: RE: Great piece on marketing collateral
Next by Author: RE: Re: Great piece on marketing collateral
Previous by Thread: Re: I don't want to be a PANE, but...
Next by Thread: RE: Acronyms in documentation?


What this post helpful? Share it with friends and colleagues:


Sponsored Ads