RE: Procedures - Must we use numbered steps?

Subject: RE: Procedures - Must we use numbered steps?
From: "Ron Hearn" <RHearn -at- cucbc -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 18 Apr 2006 15:02:03 -0700

Occasionally, there is a need to refer to a particular step or steps
outside a procedure or within another procedure - for example, "Repeat
Steps 2 and 3 above...)". In such cases, numbered steps are definitely
helpful. The alternative is to repeat the step(s) at the point of
reference.

Ron


-----Original Message-----
From: techwr-l-bounces+rhearn=cucbc -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+rhearn=cucbc -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Steven Brown
Sent: Tuesday, April 18, 2006 6:39 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Procedures - Must we use numbered steps?

Hello all,

We spend a great deal of time formatting numbered
procedures and the numbered substeps that are often
embedded within them. (How many times have we
struggled with Word's autonumbering?) It's become an
accepted practice that when you write a procedure, you
use numbers to show the sequence of steps.

But I wonder, is it really necessary to use numbered
steps at all? Gordon Meyer's Usable Help blog
(http://www.g2meyer.com/usablehelp/index.html)
recently discussed what techncial writers might learn
from recipe writers. While he doesn't raise the issue
of numbered steps, it struck me that recipes rarely
use numbered steps at all, yet somehow cookbook
readers are able to follow a fairly complex sequence
of tasks.

So I ask, have you ever considered writing procedures
without numbers?

(And please, please. I'm not suggesting that numbered
procedures should be struck from all technical
documentation, so please don't raise the typical Space
Shuttle and nuclear reactor examples to prove a point.
I'm merely wondering if numbered steps must be used in
all situations.)

Steven Brown



__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content

delivery. Try it today!. http://www.webworks.com/techwr-l

Doc-To-Help includes a one-click RoboHelp project converter. It's that
easy. Watch the demo at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as RHearn -at- cucbc -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit
http://lists.techwr-l.com/mailman/options/techwr-l/rhearn%40cucbc.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: RE: Overuse of gerunds in headings
Next by Author: RE: Administrators or Administrator's Manual
Previous by Thread: RE: Procedures - Must we use numbered steps?
Next by Thread: RE: Procedures - Must we use numbered steps?


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


Sponsored Ads