RE: Help on Procedure Writing

[Jim Shaeffer <jims -at- spsi -dot- com>]

So, Steve, 

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

Thanks, 
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? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ 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 
http://www.raycomm.com/techwhirl/ for more resources and info.