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: another word for steps From:"David Chinell" <dchinell -at- msn -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 27 Aug 2002 11:52:05 -0400
First, I think the confusion between STEPS and steps may be
illusory. Especially if you NEVER x-ref to the STEPS from
within the steps. If you have to (as in "skip ahead to Step
4. Frammis...") then you could follow this example.
==========
FRAMMISING THE MARK IV HOOZISTAT
To frammis the hoozistat, you'll follow these general steps:
1. Remove the access plate.
2. Strip away the old membrane.
3. Expose the hoozistat.
4. Frammis with the frammulizer.
5. Cover the hoozistat.
6. Install a new membrane.
7. Replace the access plate.
Details of these steps follow below.
1. REMOVING THE ACCESS PLATE
Here is some background text about removing the access
plate. It sets up the following detailed steps.
To remove the access plate:
1. Strike the topmost bolt head smartly.
2. Use a 14 mm crescent wrench to remove the bolt.
3. Repeat steps 1 and 2 for the remaining bolts.
4. Allow the access plate to fall to the ground.
2. STRIPPING AWAY THE OLD MEMBRANE
Etc. Etc.
==========
I think you get the idea. Set up the meta-steps with the
numbered list. Repeat the numbers to give them a sense of
where they are in among the meta-steps. If you x-ref
restrict the word "step" x-refs among the little steps. To
x-ref to a meta-step, omit the number. Example:
If your hoozistat is an earlier model than the Mark IV, skip
ahead to "Installing a new membrane" later in this topic.
Bear
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
