RE: On the value of glossaries containing terms the audience should already know

Subject: RE: On the value of glossaries containing terms the audience should already know
From: "Al Geist" <al -at- geistarts -dot- com>
To: "'Gene Kim-Eng'" <techwr -at- genek -dot- com>, "'Elissa K. Miller'" <emiller -at- doubleknot -dot- com>, "'techwrl'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 19 Dec 2013 19:17:13 -0500

Gene Kim-Eng wrote:

"There's ALWAYS going to be somebody looking at a manual who doesn't have
the technical chops to understand every acronym in it. Leaving out the
definitions will almost certainly increase the odds that that somebody will
be the person whose signature is needed on a contract or PO to buy the
product."

I would like to add to what Gene said. There are many of us who are
long-time tech writers with the "technical chops" that still don't
understand every acronym in a manual. You can either define the term upon
first use, but those "first use" instances can get lost. An easy to find
definitions list ensures the meanings of those acronyms do not get lost
along with that contract or PO.

Al Geist-Geist Arts
Fine Art Photography
Mobile: 231-301-5770
E-mail: al -at- geistarts -dot- com
Website: www.geistarts.com
Facebook: Geist Arts
See Also:
Technical Communication, Help, Documentation Management

"We can't solve problems by using the same kind of thinking we used to
create them." (Albert Einstein)



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
On the value of glossaries containing terms the audience should already know: From: Elissa K. Miller
Re: On the value of glossaries containing terms the audience should already know: From: Gene Kim-Eng

Previous by Author: RE: "either case" vs. "both cases" ?
Next by Author: RE: On the value of glossaries containing terms the audience should already know
Previous by Thread: Re: On the value of glossaries containing terms the audience should already know
Next by Thread: Re: On the value of glossaries containing terms the audience should already know


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

Sponsored Ads


Sponsored Ads