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 II From:TIMMERMAN <timmerma -at- IPDLINK -dot- IPD -dot- ANL -dot- GOV> Date:Thu, 31 Oct 1996 13:40:53 CST
Margaret Packman asked,
How should I number steps within longer procedures. For example, I
have one procedure to document that's 47 steps long. I realize that
the obvious answer is for the engineers to make the procedure shorter,
but until that happens, I have broken it down to smaller chunks of 3-5
steps, with an header describing the overall step.
The longest procedure I've written contains about 50 pages (not
steps). The shutdown procedure for the same system is also about 50
pages long. Lots of steps, huh? I aggree that small blocks of steps
are easier to handle than one continuous long list. Our solution is
as follows:
FRAMIS START-UP PROCEDURE
1. On the Service Floor
1.1 At the Frump Pump
1. Rotate the ________ valve, CAV-1, fully clockwise.
2. Rotate the ________ valve, CR-3, fully counterclockwise.
3. Trip the ________ lever.
1.2 At the _______ Control Panel
1. Toggle the black _______ switch to the _____ position.
2. Press the green ________ button.
3. Trip the ________ lever.
1.3 etc.
2. On the Operating Floor
2.1 At the ______ Control Panel
1. Toggle the black _______ switch to ____.
2. Press the green ______ button.
3. Rotate the ________ valve, CA-1, fully clockwise.
2.2 etc.
If you don't like the modified military numbering format, use
different styles of heads (All caps, bold, initial cap, italic,
indented,etc.) for each level.
FRAMIS START-UP PROCEDURE
ON THE SERVICE FLOOR
At the ______ Pump
1. Rotate the ________ valve, CAV-1, fully clockwise.
2. Rotate the ________ valve, CR-3, fully counterclockwise.
3. Trip the ________ lever.
At the _______ Control Panel
1. Toggle the black _______ switch to the _____ position.
2. Press the green ________ button.
3. Trip the ________ lever.
ON THE OPERATING FLOOR
At the ______ Control Panel
1. Toggle the black _______ switch to ____.
2. Press the green ______ button.
3. Rotate the ________ valve, CA-1, fully clockwise.
Regards,
Don Timmerman, dtimmerman -at- anl -dot- gov
Argonne National Laboratory
