Re: Process Documentation

Subject: Re: Process Documentation
From: Steven Brown <stevenabrown -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 11 Sep 2002 11:31:08 -0700 (PDT)


Lorraine,

I have a feeling you're better prepared to create this
documentation than you think. Don't get hung up on the
word "process." If the term sounds foreign, just think
procedure, because really, a process is just a bunch
of procedures gathered to accomplish a goal.

As others have suggested, you'll likely find a series
of procedures/tasks/processes such as:

- Entering an item
- Evaluating an item (e.g., distinguishing bugs from
enhancement requests)
- Assigning items
- Testing items
- And so on....

So approach this assignment as you would any other.
Interview your SMEs, document the way things work now,
and then begin creating an outline that shows the new
process.

Good luck,
Steven Brown
Senior Technical Writer



__________________________________________________
Yahoo! - We Remember
9-11: A tribute to the more than 3,000 lives lost
http://dir.remember.yahoo.com/tribute

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Acrobat & FrameMaker Seminars: PDF Best Practices, FrameMaker-to-Acrobat
Advanced Techniques, FM Template Design, Single Sourcing with FrameMaker
in Brussels (Oct), and in Montreal & Dallas (Dec): http://www.microtype.com/1

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 http://www.ehelp.com/techwr-l

---
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
http://www.raycomm.com/techwhirl/ for more resources and info.



References:
Process Documentation: From: Lorraine Kiewiet

Previous by Author: Re: Consequences of not Having Operational Documentation in Place
Next by Author: Re: Funny tech writing
Previous by Thread: Process Documentation
Next by Thread: Re: Process Documentation


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


Sponsored Ads