Re: Validating documentation

Subject: Re: Validating documentation
From: Bruce Byfield <bbyfield -at- axionet -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sat, 23 Mar 2002 18:59:26 -0800


Andrew Plato wrote:

Since technical writers are supposed to own their documents and be responsible
for the content, any error in the document would therefore be something for the
writer to correct. It is not the engineers or QA's fault that a technical
writer placed the wrong (misleading, incomplete, etc.) content into a document.
QA and SME's are there to catch errors. It is the writer's job to repair them
or make sure they are not there in the first place.
Yes and no.

If a writer suddenly starts complaining about lack of cooperation when asked why the docs are wrong or when late, then I have little sympathy. The odds are that the writer is making an excuse. Probably, the writer either doesn't understand the material, or has been hiding some ongoing communication problems that should have been solved long before the matter reached a crisis.

However, if the writer has been having trouble getting cooperation throughout the project, and has either kept a record of the problem or (better yet) kept his or her supervisor informed of the problem, that's another matter. It also depends on how firm the code freeze has been. If the product suffers from feature creep, especially at the last moment, then realistically the writer probably needs extra time to accomodate changes.

--
Bruce Byfield 604.421.7177 bbyfield -at- axionet -dot- com

"A river follows the path of least resistance, and that's why the river is crooked."
- Utah Phillips






^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PC Magazine gives RoboHelp Office 2002 five stars - a perfect score!
"The ultimate developer's tool for designing help systems. A product
no professional help designer should be without." Check out RoboHelp at
http://www.ehelp.com/techwr
---
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.



Follow-Ups:

References:
Re: Validating documentation: From: Andrew Plato

Previous by Author: Re: stock options
Next by Author: Re: stock options
Previous by Thread: Re: Validating documentation
Next by Thread: Re: Validating documentation


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

Sponsored Ads


Sponsored Ads