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.
Subject:RE: I'll stop now From:"Steve Hudson" <steve -at- wright -dot- com -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 2 Oct 2001 10:51:10 +1000
Yes, this is a common area for misunderstanding.
The ISO9000 manuals explain it very nicely, but the gist is this:
A process defines roles, communication channels, inputs and outputs. It
declares what procedures are used in what situations. It must allow for all
transformations of inputs into all possible outputs.
The procedures say What, Who, Where and When. If What needs more How, one
provides a breakout to Work Instructions which describe How - not Who What
When and Where.
To formalise, my procedure structure looks like this:
Scope
Considerations (all the non-step stuff from the proc + required ref
material)
Prerequisites (can include knowledge)
Authorisation (who to preform, who to give the go-ahead, who has change
management over the proc if not covered by the book/sections/chapter)
Procedure (numbered steps)
Troubleshooting (includes contact info or ref to such if applicable)
Related Documentation (same as "See Also")
Records (what Q records are used/genned by the proc)
Steve Hudson
Principal Technical Writer
Wright Technologies (Aus)
steve -at- wright -dot- com -dot- au
(612) 9518-1822
The best way to predict the future... is to create it!
Planning to attend IPCC 01, October 24-27 in Santa Fe? Sign up by
October 3 and get a substantial discount! Program information,
online registration, and more on http://ieeepcs.org/2001/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.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.