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.
One of my favorite items in my collection of good techwriting samples
IS a cookbook -- actually a 2-volume set, Julia Child's et. al.
"Mastering the Art of French Cooking".
The first of these was published in 1961, well before DTP or any other
form of computer-assisted book editing or manufacturing. The
publisher took care to design the book's layout to *enhance* the
content and intent of the writing (what a concept!).
Recipes are presented in two columns. Left column lists *utensils*
as well as ingredients for each major part of the recipe. I can see at
a glance whether I have everything I need to make it. Right column
has prose instructions, not numbered steps; they are consistently written
in the order you do them, with possible exceptions noted at the point
they occur. If you can prepare part of a recipe ahead of time, it is
clearly marked as such. Instructions to continue note any extra step
if there was a hiatus, e.g., "Let the bowl of chilled sauce come to
room temperature before proceeding." Variations of a recipe are
presented at the end, cross-referenced to other recipes as needed.
My favorite part is the index. These were clearly done by a professional
indexer, with entries listed under their major terms. E.g., "Vegetables,
Hot, Eggplant" and "Eggplant". Most certainly NOT "Mary Jane's Eggplant."
(I have another cookbook that *is* indexed like that -- and thereby
rendered useless. One of these days I'll make a good index for it.)
Best of all IMO, the index of Volume 2 is cumulative and printed in two
colors, so you only have to look in one index to find anything in the set
and it is obvious at a glance which book your recipe is in.
I learned not just French cooking, but cooking in general from these
books, because the whys of the basic techniques are clearly explained,
and discussed separately from the whats of a particular recipe. If you
don't know these books, I suggest looking them up and studying
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.