 |
|
But what is "untechnical writing?" Bremer was a manager of writing at Maxis, where he wrote documentation for games such as SimAnt and SimCity 2000. He feels that more technical writing should be written for the consumer. The book's subtitle is "How to Write About Technical Subjects and Products So Anyone Can Understand."
Much technical writing would be unnecessary if products were better designed, and the untechnical writer (properly trained and properly aware of interface design) is uniquely able to carry the torch for better products. One example is the door. A poorly designed door needs a one-word instruction manual -- "Push" or "Pull" -- because looking at the door and handle is not enough to invite pushing or pulling, says Bremer.
But if untechnical writing is writing that the consumer can understand, what is technical writing -- the usual variety? Writing by technicians to be read by other technicians?
Although I don't agree that all previous technical writers directed their prose to just the technically trained, Bremer devotes most of the book to the type of writing he prefers; a clearer, more direct, more friendly form of writing -- which, most of all, should be understood by readers without a technical background.
And, if UnTechnical Writing is the end product of the author's having practiced what he preaches, what he preaches works pretty well. This is an easy to read, well-formatted, visually-appealing book with lots of well thought-out suggestions for the writing and editing process.
It is foremost about writing in a company, or at least in an environment with lots of other people to deal with: graphic artists, editors, interface designers, or usability testers.
It is for this reason the book has chapters on the untechnical reader (audience analysis), editing, working with graphics artists, user-interface design, and writing philosophy. All of this is spooned out in small doses in the author's cordial style spiced with mild humor.
For example, one suggestion -- use humor in your writing, but don't overdo it -- is welcome in a marketplace where many technical books sprinkle humor into the mix too liberally; as I am doing here with this cooking metaphor.
Bremer's approach is to offer up his experience, (which usually sounds right on), present an opposing viewpoint, and leave you to be the ultimate guide. For example, about editing yourself, after giving several suggestions of his own: "Find what works for you, then do it". This low-key approach makes it much more likely you will adopt some of the spoken-about techniques.
Many of the suggestions are quite unsurprising. To plan a project, the untechnical writer finds out early on what he or she is to be writing. How many books will be written? Has management signed on for a manual plus a Quick Start Guide; or will the writer have to lobby management for more manual space?
While the programmers struggle with their code, the writer begins writing sections of the manual as parts of the software become available. Sections that cannot yet be written about are covered by inserting notes between brackets (or some other lexical device). Graphics callouts, captions, notes to do such and such when Bob gets back to me; all are put off for later. At some point before shipping the writer then finds and replaces this text. Such a device can also be used to make a quick list of tasks left to be done.
I'm sure there are lots of tools to automate some of these tasks, but Bremer doesn't prejudice the reader toward one tool, word processor, or page layout program versus another. Nor does he take sides in the Macintosh versus PC debate. In fact, Bremer seems to prefer fairly low-tech techniques such as checklists: for manual writing, for tracking the progress of three different writers on one project. Programmers tapped to do their own docs will be less interested in these than in the general advice and writing philosophy. Speaking of philosophy, there is a strong populist message in this book: In the real world, writing is often done by whoever is around, and appears to management to have the time. And this is the author's ultimate point. Bremer is not insistent that writing be done by a priesthood of English majors: "whoever is around" can do a good job, with the right desire to communicate and the time to do it. The idea that a writer, whether communicating through manuals, online help, or a label on the shrinkwrap; can make products better by seeing what works and what doesn't; that a person can change things if given access to the right tools, is seriously reminiscent of the Whole Earth Catalog. And the publisher, "UnTechnical Press" is alternative-sounding enough to put one in mind of the People's Computer Company, publisher in the early years of Dr. Dobb's Journal.
If UnTechnical Press can find more experienced authors who address the reader as directly as Bremer, their publications might go on to have a similar longevity.
-- Doug Nickerson (dougnickerson@yahoo.com)
|
Explanation of ERCB rating scale:
|
