Lots of acronyms (Was: Nitpicky little style question)

Subject: Lots of acronyms (Was: Nitpicky little style question)
From: "Jonathan West" <jwest -at- mvps -dot- org>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 13 Dec 2006 16:04:46 -0000

Al Geist said:
> As for habits and readers....if you call a radio button an "Fred's
> Folly," provide a definition and use the term consistently throughout
> your documentation, I don't think the readers would be lost in cyberspace.

This is a point of curiosity to me. I have seen some technical documentation
that was absolutely awash with defined terms and acronyms - on an some pages
I would count 50 or even 100 such items.

Obviously, where the documentation is paper, not much can be done to help
the user understand the meaning of those terms except to provide an
excellent index and glossary. But for electronic documentation, in principle
every last occurrence of those defined terms and acronyms could be
hyperlinked back to where its meaning is defined, so the real meaning is no
more then a mouse click away.

Does anybody work with documentation that is like this, and do you make any
attempt to hyperlink acronyms and definitions?

Jonathan West


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

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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/archive%40infoinfocus.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.


Re: Nitpicky little style question: From: Al Geist

Previous by Author: RE: Why I like this list but not OT (long)
Next by Author: RE: Lots of acronyms (Was: Nitpicky little style question)
Previous by Thread: RE: Nitpicky little style question
Next by Thread: Re: Lots of acronyms (Was: Nitpicky little style question)

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

Sponsored Ads