TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
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