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: Robert Lauriston <robert -at- lauriston -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 15:46:40 -0800

Elissa said, "I don't think you have any business mucking around with
*anything* covered in this guide if you don't know what DNS and IP
mean," which might mean she's got a similar audience.

For example, if I were documenting a command-line interface for a
piece of hardware that lives in an equipment closet, such as a big
router or network switch, I would never waste time and space defining
DNS or IP. You don't have a key to the closet if you don't know a lot
more than that. If you're some clueless user dealing with an
emergency, you need to call tech support and have them guide you.

On Fri, Dec 20, 2013 at 2:44 PM, Fred Ridder <docudoc -at- hotmail -dot- com> wrote:
> Robert Lauriston wrote:
>
>> When you're documenting a mission-critical product that's used only in
>> secure environments with hundreds or thousands of servers, you don't
>> have to worry about that.
>>
>> On Fri, Dec 20, 2013 at 1:29 PM, Gene Kim-Eng <techwr -at- genek -dot- com> wrote:
>> > 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.
>
> But that is going to be the case for how many list members? Pronouncements that only apply to one in a hundred members are not very helpful to the other 99. Most of us work in the real world where pointy-haired bosses are all too common.


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


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
Re: On the value of glossaries containing terms the audience should already know: From: Gene Kim-Eng
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: Fred Ridder

Previous by Author: Re: On the value of glossaries containing terms the audience should already know
Next by Author: Re: 12 High-Paying Jobs For People Who Don't Like Math
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