Re: Numbering in Procedures
I have a question for the list. I am currently revising a procedure, and
have hit a roadblock on how to set the numbering. The users/readers, do
not like numbering that goes: 1.0, 1.1, 1.1.1, 2.0, 2.1, etc. I have
managed to avoid it up until today. The numbering/outlining schemes I
used previously will not work with the current procedure because this
one is soooo involved.
The way I see it, I use the numbering system listed above and that is
currently in place for my revision, or... something else.
Any ideas out there on a overcast and gloomy Monday?
Kelly,
Usually (major emphasis on _usually_ because circumstances vary), it is better to avoid decimal numbering systems in procedures.
Such systems are appropriate in internal engineering specs, if your readers like them (ask!); but in procedural instructions they just get in the way.
What works better is to use headings and bulleted lists to break up the job into manageable chunks and then number the steps in those chunks with integers. For example:
INSTALLING A FRAMMIS
Installing a frammis consists of:
• Preparing the workspace
• Unpacking the frammis container
• Assembling the frammis
• Configuring the frammis
• Attaching the frammis to the fisteris
• Testing the completed assembly
• Cleanup
Preparing the Workspace
Preparing the workspace consists of:
• Clearing a 12 x 15 work area
• Mopping the floor
To mop the floor:
1. Fill a bucket
2. Stick the mop in it
etc.
etc.
Unpacking the Frammis
To unpack the frammis:
1.
2.
3.
HTH,
Dick
---
[This E-mail scanned for viruses at mail.fiam.net]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
NEED TO PUBLISH YOUR FRAMEMAKER CONTENT ONLINE?
“Mustang” (code name) is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to Web, intranets, and online Help.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! See a live demo that
will take your breath away: http://www.ehelp.com/techwr-l3
---
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.
References:
Numbering in Procedures: From: Oja, W. Kelly
Previous by Author:
Re: Finding a job with RSI
Next by Author:
Re: Conducting a postmortem
Previous by Thread:
Numbering in Procedures
Next by Thread:
Re: Numbering in Procedures
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads