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:Dan Goldstein <DGoldstein -at- cytomedix -dot- com> To:"TECHWR-L (techwr-l -at- lists -dot- techwr-l -dot- com)" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 20 Dec 2013 16:03:52 -0500
The document was written by engineers for sys admins, i.e. the writers already know that the readers know the acronyms. Someone wants 'em there anyway.
The OP is new at the gig, and should defer to the engineers' judgment in this regard. No harm, no foul.
From: Robert Lauriston
Sent: Friday, December 20, 2013 11:45 AM
To: Elissa K. Miller; techwrl
Subject: Re: On the value of glossaries containing terms the audience should already know
I think it would be weird to define RFC, SSH, LDAP, DNS, or IP in a document aimed at network administrators or the like. That would be like defining "tire" in a car manual.
If somebody wonders what USB stands for they can Google it.
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.