RE: Process Documentation

Subject: RE: Process Documentation
From: "Wilcox, Rose (ZB5646)" <Rose -dot- Wilcox -at- pinnaclewest -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 11 Sep 2002 14:31:32 -0700

>Hi Wrlers,
>By next Tuesday, I have to come up with some ideas for documenting a work
>process. [snip]

I will also add one more note. A process can span several groups or roles. Make sure the roles are defined in the document, along with responsibilities. You might consider a tabular form. Many of my clients love a step table showing the task and who is responsible for it, something like:

1. Enter the bug fix request in the Super Wonderful Bug Tracking system. Anyone
2. Assign the bug fix a priority code. QA Manager
3. Assign the bug fix to a developer. Development Manager


Also many of my clients have found process flow charts helpful.

Rose A. Wilcox
Projects and Deployment
Communications Specialist / Technical Writer
Rose -dot- Wilcox -at- PinnacleWest -dot- com
"I can write better than anybody who can write faster, and I can write faster than anybody who can write better."
- A. J. Liebling (1904-1963)

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: Goofy Consultants...
Next by Author: RE: Questions about the Technical Writing field
Previous by Thread: Re: Process Documentation
Next by Thread: Process Documentation

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

Sponsored Ads