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.
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.