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: Procedural Steps From:Parks Bev <parksb -at- HUACHUCA-EMH8 -dot- ARMY -dot- MIL> Date:Wed, 30 Oct 1996 10:13:00 PST
Eric J. Ray [SMTP:ejray -at- RAYCOMM -dot- COM] asked about writing procedural
steps:
>>
I've been doing some research into using procedural
steps, as in:
1. Select some text.
2. Click the B button.
3. Do something else.
<snip>
I've always assumed that each numbered step should
reflect an action on the part of the reader. That is,
if there are three things the reader must do,
there should be three steps. I've found that many
books present the information as
1. Select some text.
2. The text will appear highlighted on the screen.
3. Click the B button.
4. The text will be boldfaced.
5. Do something else.
<snip>
<<
=====
I use a combination of the two examples you gave. Like you, I believe the
numbered steps should reflect action, but the results should be included
as well. Like this:
1. Select some text.
The text will appear highlighted on the screen.
2. Click the B button.
The text will be boldfaced.
3.. Do something else.
Something else happens.
The steps are usually in a larger, perhaps bolder, font. The results are
in whatever normal font I'm using for paragraphs.
Bev Parks
parksb -at- huachuca-emh8 -dot- army -dot- mil
(Delete the attachment; it is meaningless and beyond my control.)