Re: Validating documentation

Subject: Re: Validating documentation
From: "Mike Frasciello" <MJFrasci -at- uc -dot- syr -dot- edu>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 22 Mar 2002 14:16:36 -0500

Back in the day technical writers they key component of the software
development process. We called it "documentation first." The writers
worked with the analyst to develop technical specifications. The writers
then began building user and support documentation directly from the
specs. As sections were completed, the documents were turned over to the
developers as functional specifications. After a module or section of
the software could be compiled, it was unit tested against the
functional spec - basically verifying that outcomes matched those
identified in the functional spec. Upon completion of the documentation
and the system, the docs were used as test scripts for integration

This model seems to work well in small writer/developer groups. It also
assumes that a software and documentation process follow similar
development methodologies.

All that to say, yes - technical writers should and can be closely
"linked" to software QA. No one knows how a system functions better than
those who document it.


>>> "Jackson, Malkia" <MJackson -at- dpconline -dot- com> 03/22/02 01:51PM >>>

My company is considering a more formal approach to validating the
sections of our operator manuals by developing a more intimate alliance
our internal software QA department. Specifically, we are considering
asking software QA to validate the operator manual at the same time as
software builds are tested.
I have some questions - Any ideas on how such a relationship can best
for all parties involved? Is this a natural alliance (i.e. should
techwriters of software be closely linked with SQA)?
Thanks for the input.


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

Previous by Author: re: word count in Frame book
Next by Author: RE: documentation validation
Previous by Thread: Re: Validating documentation
Next by Thread: RE: Validating documentation

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

Sponsored Ads