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:"Chuck" <writer -at- best -dot- com> To:techwr-l Date:Wed, 27 Oct 1999 14:15:00 -0700
Mason, Catheryn <CMason -at- INFINITEC-COM -dot- com> wrote in message news:27049 -at- techwr-l -dot- -dot- -dot-
>
> A poster at Ace Hardware inquiries about documenting repeated steps
> -- "some of us are stating "Repeat steps 2 and 3 to/until...", while
> others are stating "In order to..., repeat steps 2 and 3". "
>
> When I use repeated steps, I specify the condition to be met first, then
> specify the steps to be repeated. For example, "If additional transport
> facilities are required, repeat steps 2 and 3." In other words, I supply
the
> reason or outcome first, followed by the action.
I would agree in part, except that it depends. It may not be conditional.
Perhaps repetition is required. For example, "Repeat steps 2, 3, and 4 until
all cells are filled with information." In such a case, the procedure isn't
complete, or a user can't continue with the procedure and have it work
correctly, without the repetition. If that's the case, I'd explain just that
in a sub-paragraph after the repetition instruction: "If you don't fill all
the cells, the frabberjatz calculation will not be correct."
As a side note, "In order to..." is wordy. Use just "To..."
--
--
Chuck Martin
writer"at"best"dot"com www.writeforyou.com
"[Programmers] cannot successfully be asked to design for
users because...inevitably, they will make judgments based
on the difficult of coding and not on the user's real needs."
- Alan Cooper
"About Face: The Essentials of User Interface Design"
NOTICE TO BULK EMAILERS: Pursuant to US Code,
Title 47, Chapter 5, Subchapter II, 227, any and all
nonsolicited commercial E-mail sent to this address is
subject to a download and archival fee in the amount of $500
US. E-mailing denotes acceptance of these terms.