[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Lots of acronyms (Was: Nitpicky little style question)

Subject: Re: Lots of acronyms (Was: Nitpicky little style question)
From: Al Geist <al -dot- geist -at- geistassociates -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 13 Dec 2006 11:42:15 -0500


Jonathan West wrote:

I'm not thinking of end-user documentation, but rather things like technical
specifications where meanings must be very specific, and where the document
is intended for a readership that is already knowledgeable on the general
topic.



Thanks for the clarification. The problem here is that you can never assume that everyone knows what everything means. So, in your need to define everything, you end up creating a document that takes forever to wade through. Technical specs, however, are different in that you need to ensure all the readers are on the same plane and that means defining everything. A definition's list may work as long as it is an integral part of the paper document and not an attachment that can get lost. If its electronic, then hyperlinking each term to a definition would probably work. The readers who already know what the term means will pass over the hyperlink. Those that don't know what the term means have the option of jumping to the definition or blissfully nodding their heads in agreement and hoping nobody asks them a question about it.

Al
--

Al Geist
Technical Writing, Online Help, Marketing Collateral, Web Design, Award Winning Videos, Professional Photography
Voice/Msg: 802-658-3140

Cell: 802-578-3964
E-mail: al -dot- geist -at- geistassociates -dot- com <mailto:al -dot- geist -at- geistassociates -dot- com>
URL: www.geistassociates.com <http://www.geistassociates.com> (online portfolio/resume)

See also:
URL: www.geistimages.com <http://www.geistimages.com> (fine art prints for home for office, and note cards for all occasions)

"When they call the roll in the Senate, the Senators do not know whether to answer "Present" or "Not guilty.""
Theodore Roosevelt


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

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.

References:
RE: Lots of acronyms (Was: Nitpicky little style question): From: Jonathan West

Previous by Author: Re: Nitpicky little style question
Next by Author: Re: Nitpicky little style question
Previous by Thread: RE: Lots of acronyms (Was: Nitpicky little style question)
Next by Thread: RE: Lots of acronyms (Was: Nitpicky little style question)

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads