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: instructions for a pb&j sandwhich - a little OT
Subject:RE: instructions for a pb&j sandwhich - a little OT From:"Sean Brierley" <sbri -at- haestad -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 28 May 2002 13:11:45 -0400
The core of my disagreement is this: Sean H.'s tale is amusing, not
really informative. Is writing instructions for PB&J sandwiches, or any
other kind of sandwich for that matter, really and truly a *difficult*
task, for a novice writer or for those who *know* how to write
instructions. Do instructions for making a sandwich really need to be
preceded by a list of assumptions made by the writer?
Agreed, I too would think twice about hiring a guy whose instructions on
making a sandwich included "putting a glass jar" between the slices of
bread. However, if those words weren't explicitly written, I'd look long
and hard at the person who interpreted the instruction that way . . ..
Now, if those who follow the instructions are known to be going out of
their way to misinterpret the instructions, I say that can be funny, but
I do not say that those deliberate deviations from the norm are really a
guide to how a document should be written.
I find Sean H's tale both informative and amusing, and serves to
illustrate that even writing instructions for simple tasks can be
difficult. <snip>
If concerned about what to assume, ASK the interviewer. Or create an
"Assumptions" section at the beginning of your doc, which demonstrates
that you understand the need to eliminate any ambiguity about your
audience's skills.
A "professional" tech writer whose instructions led me to putting a jar
of
peanut butter between two slices of bread would be somebody I'd think
twice about hiring.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
