Re: Subject Matter Expertise-YES!

Subject: Re: Subject Matter Expertise-YES!
From: Jan Henning <henning -at- r-l -dot- de>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 27 Feb 2003 20:06:36 +0100


I am somewhat confused that this discussion always takes so long to resolve (if resolve is the word). I would think that a few facts are uncontentious:

1) To create good documentation, you need writing skills (including, but not limited to, being able to structure facts, to acquire facts, to write readably and understandably in the language of choice).

2) You need to have a certain amount of knowledge on the subject at the time when you write (which is usually not the time when you start the job). The exact amount varies from job to job.

3) The more you know about the subject matter, the better it is, all other things being equal.

4) You need to be able to understand the needs of the users of the documentation well enough so that you can present the subject matter in a way that makes sense to them and helps them do whatever they need to do.

If the above statements are accepted, it seems fairly pointless to argue about whether you need to be an 'expert' to write about anything, especially since there is no common understanding on what exactly an 'expert' is.

It seems also fairly pointless to argue abstractly about exactly how much subject matter knowledge you need, since this is different from case to case - as has become obvious from the different experiences reported in this discussion.

It appears to me that the major part of the discussion does not involve any real examination of the issue at all, but participants battling over definitions and insisting on their personal experiences being more indicative of the 'real' requirements of a writer.

Regards
Jan Henning


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


LAST CHANCE for this steal of a deal! Purchase RoboHelp X3 by February 28
and receive $100 mail-in rebate and FREE WebHelp Merge Module ($339 value)!
RoboHelp, the Industry Standard in Help Authoring, has won over 55 industry
awards. For more information please visit: http://www.ehelp.com/techwr-l2.


"RoboHelp X3 is simply remarkable." - George Bell, Techno-Vision Systems


---
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
http://www.raycomm.com/techwhirl/ for more resources and info.



References:
RE: Subject Matter Expertise-YES! Attack Iraq-NO!: From: tom -dot- green -at- iwon -dot- com

Previous by Author: Re: Have to know Programming to be able to write about it? -- NO
Next by Author: Re: Synonym for binary file?
Previous by Thread: RE: Subject Matter Expertise-YES! Attack Iraq-NO!
Next by Thread: Re: Subject Matter Expertise-YES! Attack Iraq-NO!


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


Sponsored Ads