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: Acronyms in documentation? From:Mailing List <mlist -at- ca -dot- safenet-inc -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 28 Apr 2004 14:11:34 -0400
Responding to Geoff H, Gene Kim-Eng let it be known that:
> 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.
Often, that's just fine, but due to the nature of our
product and industry, some pages can be alphabet soup,
looking like one big link. . . or a ransom note.
Anyhoo, I appreciate the reasoned comments from all
parties. It's good to get several perspectives when
pondering ponderous ponderables.
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.