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: Repeating Steps Task From:JohnMethod -at- aol -dot- com To:techwr-l -at- lists -dot- raycomm -dot- com Date:Thu, 28 Oct 1999 11:50:43 EDT
Hello, the list!
In a message dated 10/27/99 4:53:17 PM EST, Johnst -at- memo -dot- acehardware -dot- com
<< [...] I work with a team of doc writers & we are writing online docs
(using RoboHELP HTML 7.0). [...] One area we need to set a standard on is how
to document "repeating steps". For example, some of us are stating "Repeat
steps 2 and 3 to/until...", while others are stating "In order to..., repeat
steps 2 and 3". I would be interested in learning how other writers are
handling the "repeat step" task. [...] >>
An approach that seems easily understood follows the structure of programming
languages: Declare that the *following* steps are to be executed if and/or
until some conditions are met.
The user then knows that the next chunk of "code" is a procedure of its own.
The procedures can also be "external" - like "Edit the document as described
in Section 3, 'Editing Documents'." or nested.
Crudely (one liners, not paragraphs, and omitting lots of good practices):
UNWHOMPERING - If the Wonderful Widget Whacker is whompered, then:
Open the Tweak Log Window as in Section 2.5.
TWEAKING - For each Thingy in the Wonderful Widget Whacker:
Select a Thingy in the "Thingies" combo box control.
The Tweak Log Window software displays the current Thingy value
in the "Current Value" text box control.
Tweak the Thingy as in Section 3.
Type the desired new Thingy value in the "New Value" edit control.
CHECKING - The Tweak Log Window software:
Checks that the new Thingy value is cool.
If the value is cool, the Tweak Log Window software:
Saves the new Thingy value.
Disables the Thingy entry in the combo box control.
Presents an empty Tweak Log Window for the next Thingy.
Otherwise, the Tweak Log Window software:
Highlights the new entry, for correction.
CHECKING is complete.
TWEAKING is complete.
The Tweak Log Window closes after you tweak the last Thingy.
UNWHOMPERING is complete.