RE: Help on Procedure Writing

Subject: RE: Help on Procedure Writing
From: Jim Shaeffer <jims -at- spsi -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 6 Dec 2001 09:28:01 -0500

So, Steve,

1. Does your "proc structure" contain any Instructions?
2. What is a numbered procedure if not an Instrutction?

Jim Shaeffer (jims -at- spsi -dot- com)

> -----Original Message-----
> From: Steve Hudson [mailto:steve -at- wright -dot- com -dot- au]
> Generally User Manuals have instructions, not procedures.
> Procedures must state who, what, where, when and why.
> Instructions tell How.
> FWIW, a neato proc structure I developed to contain all
> relevant info is:
> Scope (sometimes as simple as the title eg Eating Lunch in
> the Lunchroom.
> Considerations (all the "Note:" and commenty type stuff)
> Prerequisites (knowledge, equipment, task completion etc)
> Authorisation (if different from the scope of the manual)
> Procedure (preferably numbered when sequential)
> Troubleshooting (include an experts # as well)
> Related Documentation (duplicate in-line links from above,
> plus any others)
> Records and Retentions (most procs require a Q record)

Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for?

Have you looked at the new content on TECHWR-L lately?
See and check it out.

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: Query: Hyperlinks in Lotus Notes forms
Next by Author: RE: When document writing does not have or follow guidelines...
Previous by Thread: RE: Help on Procedure Writing
Next by Thread: Re: Help on Procedure Writing

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

Sponsored Ads