TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
It sounds like you need to hire a Business Analyst. However, to answer your
question generically, you should list what the inputs to the process are,
what the process does to those inputs, and what outputs the process
produces.
For example, an SME give you information as an input. You analyze, organize,
write, edit, and produce a document in some format. You deliver your output,
the document, to your customer, which can be either internal to your company
or external.
It is really quite simple, but like anything else, the devil can be in the
details.
John Gilger
Senior Technical Writer
Acres Gaming, Inc.
702.914.5585
-----Original Message-----
From: Laura Winkelspecht [mailto:laura99 -at- execpc -dot- com]
Sent: Tuesday, April 03, 2001 07:57 PM
To: TECHWR-L
Subject: process templates
My boss asked me today if I knew of any templates for documenting processes.
I told him that there are several types of structured writing (like Info
Mapping, etc.), but he really just wants a list of questions/topics that
should be included in process documentation. I work for a retail company, so
we aren't talking about developing software (although we document how to use
lots of it). I think it depends on the subject being documented, but he
would like something to start from. I think his intent is to give this to
the SMEs so that they have an inkling of what we will be asking when we
start documenting their processes.
So, what questions/topics would you put in a process template (for lack of a
better term)?
Thanks,
Laura Winkelspecht
Technical Writer
ShopKo, Inc.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
---
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.
