RE: Process Documentation

Subject: RE: Process Documentation
From: "Gilger.John" <JGilger -at- acresgaming -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 11 Sep 2002 11:10:43 -0700


Think of a process as a human readable program :)

Step 1 bug finder initiaties the process: fills out a bug report. (You have to design the interface/form)
Step 2 input is verified: your QA person evaluates the form for completion and validity.
Step 3 valid input is processsed: QA person evaluates problem and places it in a priority queue (to do list)
Step 4 problem assigned to solver: The boss assigns it to someone to fix
Step 5 solver fixes bug
Step 6 solver informs boss, QA, and bug finder that bug is fixed (feed back)
Step 7 QA and/or bug finder test and verify bug fixed (testing)
Step 8 QA, boss, or bug finder <management decision here> sign off bugfix as complete, delete from queue

This process has some loops and decision points which should be obvious to the casual observer :)


John Gilger
Senior Technical Writer
Acres Gaming, Inc.

-----Original Message-----
From: Lorraine Kiewiet [mailto:Lorraine -dot- Kiewiet -at- mullinconsulting -dot- com]
Sent: Wednesday, September 11, 2002 10:47 AM
Subject: Process Documentation

Hi Wrlers,
By next Tuesday, I have to come up with some ideas for documenting a work process. (This is about how other departments at our company make requests for software enhancements, or report bugs, or other ad hoc requests. The process now is that they interrupt QA people and/or programmers and the squeakiest wheel gets the grease.) Our company is implementing an intranet tool that they will use to make the requests, with a back-end that we will use to see what's in the pipeline and manage it.

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


Lorraine Kiewiet
Senior Technical Writer

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: what's the world coming to
Next by Author: RE: Off-site work
Previous by Thread: Re: Process Documentation
Next by Thread: RE: Process Documentation

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

Sponsored Ads