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: PB&J--not just for lunch anymore (was: Getting Experience --was Volunteer TW Services) -Reply
Subject:Re: PB&J--not just for lunch anymore (was: Getting Experience --was Volunteer TW Services) -Reply From:Lisa Comeau <COMEAUL -at- CSA -dot- CA> Date:Fri, 26 Jun 1998 11:43:32 -0400
Deborah Ray wrote:
"...I use making a peanut butter and jelly sandwich to introduce instructions in TW classes that I teach. ... ask for a victim--er, um--volunteer to read his/her instructions while I follow them....they usually forget to include steps like opening the PB jar (at which point, I'm sitting there stabbing the lid with a knife) or mentioning how much PB to put on the bread (at which point I pile, say, half a jar of PB on the bread).
Good exercise. Students remember the lessons, that's for sure.
I agree, Deborah, it is a good exercise that the students will remember, *but* (like a certain Physics discussion) I believe it's unrealistic.
I think the *most important part* of this post is the following phrase
"including appropriate details based on audience needs, and so on".
Think about this. A writer *has* to make certain assumptions. If writing for an English speaking audience in a country where the minimum-wage workers can afford a jar of Peanut Butter (and that's tough sometimes), it can be *assumed* that the reader will *already know* that they have to open the jar to get the peanut butter out.
I did a similar exercise once, but the topic was boiling an egg. We were instructed to *assume* that the reader was not an alien, and knew what an egg, a stove, a pot, a tap, and a burner were, and where they would find them. Then we had to redo the exercise, and *assume* that the reader had *no idea* what those items were. This way we got *both* sides of the coin, how to get rid of extraneous information, and how to add in what might be considered "obvious" to a more "seasoned" individual.
(and in concurrence with the "anonymity" post...)
Lisa Comeau
IS Super-User/Trainer
Certification and Testing Division
Canadian Standards Association
Rexdale, ON
comeaul -at- csa -dot- ca