RE: End user documentation

Subject: RE: End user documentation
From: Paul Hanson <phanson -at- Quintrex -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 19 Aug 2008 07:45:42 -0500


In an ideal world, when a project that changes the software arrives in your QA dept for testing, the doc should be done. At that point, the QA tester would then be responsible for testing the software as well as reading the documentation and making sure it matches up.

In reality, I sometimes can get ahead of development, but mostly, I get the projects *after* they've been tested, *after* they've been released to the client.

I worked at one company from 1995-1998. Prior to a project even being *accepted* into the QA dept, someone from the doc dept had to sign off on it, meaning that they knew it was coming and had either completed the doc or had made notes that indicated what they needed to change. The Doc dept didn't have to be *done* with a project's doc changes for it to go to QA, but the Doc dept did have to know about it. It helped that our manager enforced this and turned away developers when they would bring a project without someone's signature.

It also depends upon where you fit in the process. The bulk of my career has been spent in the QA dept. If you have the same mgt as the programmers, then you should definitely be in the loop.

Good luck.

Paul Hanson
Technical Writer
RoboHelp ACE -
Quintrex Data Systems
email: phanson at

-----Original Message-----
From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Raj Machhan
Sent: Tuesday, August 19, 2008 6:15 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: End user documentation


In all probability, it is highly debatable and may vary from one product to
the other, but ideally at what stage of the SDLC should we start creating
end user documents? I am presently mapping the stages of SDLC with the
documentation process. Your views would help me greatly to arrive at a
definite conclusion.




ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

End user documentation: From: Raj Machhan

Previous by Author: RE: RoboHelp x5 to 7
Next by Author: RE: One or two LCD Monitors
Previous by Thread: End user documentation
Next by Thread: RE: End user documentation

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

Sponsored Ads