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.
Re: Action -> Result (includes a little bit of humor)?
Subject:Re: Action -> Result (includes a little bit of humor)? From:John Posada <john -at- TDANDW -dot- COM> Date:Tue, 22 Dec 1998 11:54:39 -0500
It shows how we tend to position things based on out current environment and
Currently, I am working on a manual that takes the person through a series of
steps to perform a function. In this particular piece of work, each function is
broken into 3 to 12 steps. The function is introduced by a short paragraph
describing the function, then the steps are given. The intro paragraph functions
as the end result:
1) This process will instruct you to detonate a bomb. If you do not want to
detonate the bomb, go to Step 3:
a) Open case to access the blue wire
b) Hold wire cutter, Model 3-1-a7.005, in your right hand.
c) Cut the blue wire to blow your right arm off.
d) You should be experiencing severe pain on the right side of your body.
If you are, go to Step 2. If not, contact the 24 hour help desk.
2) This process will stop you from bleeding to death:
a) Dial 555-1212 with yor left hand
Seriously...In the document I'm working on, we want them to blindly go from step
to step without exception or deviation. In another situation, I'd be writing
Brenda Ruetschi wrote:
> From: John Posada [mailto:john -at- TDANDW -dot- COM]
> I just try to do two things when I write... <more snippage>
> 2) Show the action, then show the results.
> That's interesting, because I usually do the reverse:
> To Delete the line, press Backspace.
> We do this so we don't have people blinding following the manual, doing each
> action only to realize they didn't really want to do that...
> This is related to the old story that ends, cut blue wire (turn page) to
> detonate bomb.
> Brenda Ruetschi
> Technical Communications
> Alpha Technologies, Inc.
> bruetschi -at- alpha88 -dot- com
> From ??? -at- ??? Sun Jan 00 00:00:00 0000==
John Posada, Technical Writer
Bellcore, where Customer Satisfaction is our number one priority mailto:john -at- tdandw -dot- com mailto:jposada -at- notes -dot- cc -dot- bellcore -dot- com
phone(w) 732-699-3077 phone(h) 732-2910-7811
alpha-pager: 800-864-8444 pin 1857522 http://www.tdandw.com
email pager: mailto:1857522 -at- pagemart -dot- net
My opinions are mine, and neither you nor my company can take credit for
"Give a man a fish and he will eat for a day. Teach him how to fish,
and he will sit in a boat and smoke cigars all day."
"The only perfect document I ever created is still on my hard drive."