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:Conditional statements in instructions From:DURL <durl -at- BUFFNET -dot- NET> Date:Mon, 18 May 1998 12:35:43 -0400
Am I really the cheese standing alone here?
I don't think that conditional statements should precede the
imperative verb. (When done, press return.)
As a rule, I try to put the condition as a "desired result" of the
previous imperative. Example:
(step #). Press Alt + 4.
(some visual, like an arrow) You are done.
(step # + 1). Press return.
(some visual to indicate end of procedure)
I think that parallel structure in a list of steps is critical for
readability. Secondly, research shows that people scan down the numbered
steps and skip steps that don't identify the action immediately. (OK, so
the research consists of me noticing how I do things, enlightened by
my reading. Beats nuthin!)
Mary
Mary Durlak Erie Documentation Inc.
East Aurora, New York (near Buffalo)
durl -at- buffnet -dot- net
