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

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: Gene Kim-Eng <techwr -at- genek -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 13:29:09 -0800

I've been in more than a few start-ups where some newly hired clerical employee was handed a network manual and told that he or she was now the company's sysadmin.

Engineers are great at knowing what other engineers know. As the author of the documentation, it is YOUR job to know or to find out what the end user actually NEEDS to know and then provide it.

Gene Kim-Eng


On 12/20/2013 1:03 PM, Dan Goldstein wrote:

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.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: Robert Lauriston
RE: On the value of glossaries containing terms the audience should already know: From: Dan Goldstein

Previous by Author: Re: [BULK] Re: On the value of glossaries containing terms the audience should already know
Next by Author: Re: [BULK] 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

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

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

Sponsored Ads