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:Re: Tech writers and cookbooks From:"Chuck Martin" <twriter -at- sonic -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 30 Jan 2001 12:27:27 -0800
"Steve Shepard" <STEVES -at- YARDI -dot- com> wrote in message news:89225 -at- techwr-l -dot- -dot- -dot-
> I'm a tech writer and I cook a lot. You would think a recipe in a cookbook
> and writing, say, software documentation would have some similarities.
> just as there is a fair amount of bad technical writing, cookbook recipes
> seem to be even worse.
> For example, beginning with a list of ingredients is great, but often they
> aren't in any order that makes sense. And if the prep and cooking
> instructions are numbered, they usually include several steps, not one at
> time. When the instructions are in prose, I find I often have to read the
> paragraph two or three times to figure out what I am actually supposed to
> do. And when I am told "do this, but not that" I am never told "why"
> it in a plastic or ceramic bowl, not glass).
> From the point of view of a tech writer, what would be a better way to
> present this kind of information.
> I am looking for ideas as I document (surprise) my recipes and I don't
> to fall into the same trap.
Like with any documentation, you need to focus on your user's goals. In this
case, it seems that the user is you.
Your ultimate goal is, of course, to finish the project (dish), and (as a
sub-goal) to do so with a minimum abount of effort to decipher the
information you need to reach that goal. You've identified several prtoblems
you;ve seen with a number of information designs, and it seems to me that
your solution is to resolve those problems:
- Present a list of ingredients in the order that they will be used.
- Describe one task per step.
- Add conceptual information to each step.
Illustrations can often help too.
When you focus on the user's goals, and not the tasks that the user will be
doing to get to the goal, the tasks themselves usually become much clearer.
"[Programmers] cannot successfully be asked to design for users
because...inevitably, they will make judgments based on the
difficulty of coding and not on the user's real needs."
- Alan Cooper
"About Face: The Essentials of User Interface Design"
twriter "at" sonic "dot" net www.writeforyou.com
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
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.