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.
The question seems to be: conditional info first, or action info first? To
illustrate why I believe it's best to put the conditional info first, I'll
use an example from a friend who used to teach Drivers Ed (in the car). He
said, "I've learned to tell a new driver __when__ to do something before
telling them __what__ to do. For example, 'At the stop sign, turn left.'
Otherwise I find drivers will end up turning and parking on somebody's
Sr. Technical Writer
kfield -at- stellcom -dot- com
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.
My two cents -- others may differ.
Catheryn Mason, Technical Writer
cmason -at- infinitec-com -dot- com
Winner, 1999 IABC Bronze Quill Award of Excellence for Technical Writing
Sponsored by Weisner Associates Inc., Online Information Services
Moving your documentation online? We can help with standards, planning,
or training. Visit us at http://www.weisner.com or mailto:info -at- weisner -dot- com -dot-
Sponsored by Rose Hill, Your Business and Career Coach.
"Assume Success! Live Your Passion!" Get the gist at
www.coachrose.com then call 503.629.4804 for details!
You are currently subscribed to techwr-l as: kfield -at- STELLCOM -dot- com
To unsubscribe send a blank email to $subst('Email.Unsub')
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.