Re: Process Documentation

Subject: Re: Process Documentation
From: "Diane Evans" <diane_evans -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 11 Sep 2002 17:57:27 +0000

I'm not in QA and have very little experience documenting work processes (Help and install guides are my bag). Where do I start?

Start by outlining the process as it is used by people at your worksite. For example, I am currently creating document templates for a complete "Software and Computer System Design and Development Cycle." The documents I will need are:

1. Validation Plan.
2. Functional Requirements Specification.
3. Software Design Specification.
4. Configuration Management Plan.
5. Test Specifications.
6. User Acceptance Protocol.
7. Validation Summary Report.

In addition, there is a very simple diagram showing the work flow.

Once I have the templates in place, the various managers will inform the developers and others of the process. Then, when a "squeaky wheel" comes around, the answer will be, "I haven't begun work on your Software Design Spec" because the managers have not yet approved the requirements" ... or something like that, in a perfect world.


Diane Evans
Technical Writer

Washington State Coordinator, Tombstone Project
Oregon State Coordinator, Tombstone Project

MSN Photos is the easiest way to share and print your photos:

Absolutely FREE! FrameMaker/Win 6 & 7 Express Customization (v3):
Quick-access buttons & keys to common functions, char tag/font drop-down
lists, charset browser, QRef guides & much more:

Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions 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: corrupt word file
Next by Author: Re: Questions about the Technical Writing field
Previous by Thread: Re: Process Documentation
Next by Thread: RE: Process Documentation

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

Sponsored Ads