RE: Help on Procedure Writing

Subject: RE: Help on Procedure Writing
From: "Steve Hudson" <steve -at- wright -dot- com -dot- au>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 6 Dec 2001 09:42:59 +1100

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)

Also, you need to let us know what AUDIENCE you are writing for. That's the
crucial bit.

Steve Hudson , HDK List MVP
Wright Technologies Pty Ltd (Aus) EyeSpring - the future of graphics has
been created.

-----Original Message-----
From: AnilaA -at- ibsplc -dot- com

Hi everyone

I am new to the field of Tech Writing. A graduate in English
literature, I have no background whatsoever in tech writing or in any
of the tools/technologies I see mentioned in most of the messages
posted here -- except for MS Word, MS Excel and to a certain extent

I am in need of information on the following topics:

Writing User Manuals
Writing Online Help

By this I mean the the language, style and format to be used in this
kind of procedure writing. My company does not require me to work with
the different help technologies as of yet. At present I am concerned
basically with the language part of it.

Please do let me know where to go for this kind of information.

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.

Help on Procedure Writing: From: AnilaA

Previous by Author: RE: Lotus docs --> web
Next by Author: RE: Help on Procedure Writing
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