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:Procedural Steps II From:Ron Rothbart <ron -dot- rothbart -at- DOCUMENTUM -dot- COM> Date:Fri, 1 Nov 1996 08:53:47 +0800
Margaret Packman writes:
>Now I have a question on how to number steps within longer procedures. For
>example, I have one procedure to document that's 47 steps long.
<snip>
I had one with almost the same number of steps. It's a dialog box with 5
tabs containing lots of widgets and spreadsheet-like fields. The user has to
work through all 5 tabs to complete the task.
Personally, I find the military/engineering numbering system distasteful. It
just looks too technical. Our style is to use letters for sub-steps and
bullets for alternative options. Sub-steps work like this:
8. To specify dependencies, click the Routing tab and do the following:
a. Click in a cell in the such-and-such column, enter the indentification
number, and press the Enter key.
b. xxxxxxxxxx
c. xxxxxxxx
This procedure is also "puncutated" by a screenshot of each tab. So, the
40-odd step procedure becomes 13 steps, as represented below (* represents a
filled bullet; - represents an unfilled sub-bullet).
