Re: huh?

Subject: Re: huh?
From: "Jeff Hanvey" <jewahe -at- lycos -dot- co -dot- uk>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 8 May 2003 12:24:12 -0400

This argument has been hashed repeatedly on this list - the argument of how
much subject matter knowledge a writer needs to do his/her job.

Some people contend that since the guidelines for writing good documentation
is the same no matter what your field, the writer can go from job to job and
not really need to learn the specifics of the technology. There is
something to this, since not having specific industry knowledge does help
the writer to pick up gaps in the documentation - especially those places
where basic knowledge is assumed (for example, assuming that a user knows
what "right click" means). These writers insist that good research skills
and good interviewing skills can overcome any gaps in knowledge.

There's another camp that believes that writers can't really do their jobs
unless they know their subject. Not knowing the subject leads to gaps in the
documentation, since the writer isn't aware of intermediate steps, and might
not pick up on those steps in the research.

I am in a third camp - a combination of the two. I believe that basic
knowledge of the job is necessary, and that good research skills and
interviewing skills help me to do my job. It is not necessary that I become
an expert in the matter, since I have experts all around me. It is my job to
find the right questions to ask.

However, I fully recognize that there are times when the writer needs to be
an expert - there is no "standard" level of understanding that applies to
every type of writing job out there: corporate environment, managerial
style, SME cooperation, and many other factors can dictate more or less
necessity in understanding.

Jeff Hanvey
Augusta, GA
jewahe -at- lycos -dot- co -dot- uk

----- Original Message -----
From: "Sean Hower"

> I'm asking this in all seriousness:
> -------------------------------
> Janice Gelb wrote:
> Some people even argue that in some circumstances (mostly end-user
products) it's better if editors *don't* have extensive knowledge of the
subject matter as they then are more likely to approach the material as a
user would
> -------------------------------
> Huh? Really? I don't get it. Could anyone who actually believes this
please send me an email explaining the reasoning behind such a thing? And
I'm not asking for the sardonic explanation, I really want to understand why
someone would think this
> FYI, this is not a stab at Janice, I was just surprised by this one
statement. Yes, it's taken out of context, but the statement should be able
to stand on its own. :-)


Order RoboHelp X3 in May and receive a $100 mail-in rebate, PLUS
free RoboScreenCapture and WebHelp Merge Module.

Order RoboHelp today:

ATTENTION FrameMaker Users: Fill-out the following survey
to receive a chance to win a FREE RoboScreenCapture.

FM users only please:

You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.


huh?: From: Sean Hower

Previous by Author: QUERY: translation speed statistics - part 1
Next by Author: Re: huh?
Previous by Thread: huh?
Next by Thread: RE: huh?

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

Sponsored Ads