How to Edit Technical Documents

Book Review by Garret Romaine

Donald W. Bush and Charles P. Campbell
Oryx Press, 1995
Phoenix, Arizona
186 pages
ISBN: 0-89774-870-0

In the preface of their book, Bush and Campbell introduce the term "Nintendo editing"-the practice of using style-checking software to "zap errors," usually practiced by low-paid editors following rigid style manuals and paying little attention to technical accuracy. (p. vii)

The authors believe such practices "denigrate" the noble profession of editing, and they seek to introduce a change. "This book seeks to upgrade technical editing from today's automatic wrist-slapping to a thoughtful process that applies brains and common sense. Editors need to learn to trim copy to get authors to the point quicker, and to develop continuity, paragraph coherence, and overall organization." (p. vii)

The authors speak from broad experience. Donald W. Bush is a fellow of the Society for Technical Communication who lectures at San Diego State University. He worked as a technical editor for McDonnell Douglas for 25 years. His background includes journalism, public relations, and technical editing.

Charles P. Campbell, Ph.D., is associate professor of English in the Humanities Department of the New Mexico Institute of Mining and Technology. Campbell has taught English at several universities and colleges, and spent 10 years as a technical editor. He has written articles, reviews, and papers.

As would be expected from such accomplished writers and editors, the book is well organized. There are 13 chapters with such titles as "Editing for Content" and "Cutting Copy." The final two chapters, "Triage: Dealing with Typescripts under Deadline" and "Getting Along with Authors" are especially well done.

For example, this passage toward the end of the book: "You're smart if not all of your editing marks are negative. Be sure to praise good writing highly … Editors may never have any power. Their marks may be doomed to be suggestions only; authors can take them or not. (They may actually take only about 90 percent, which is fine.) Editors should not argue unless the author's decision affects technical accuracy. The few barbarisms they leave salt the proposal with engineering flavor and help cover up any taste of public relations slickness." (p. 142)

The authors list nine points in their Advice In Dealing With Authors:

  1. Join the team. You are not grading papers; you are trying to get a message across. Don't consider editing a battle. Try to find out what the author wants to say and help him or her say it. Ask questions.
  2. Let the small things go. Save your righteous indignation for important details, like technical accuracy. (Only you and the reader may know that bad syntax distorts technical meaning.)
  3. Challenge facts first, wording second. Check numbers. Check the basic outline, the organization, the logic, and sequences. Check what's left out.
  4. Use the natural, standard idiom of the language.
  5. Learn to cut copy without losing information. Authors appreciate your help, particularly on proposals, manuals, memos, and bulletins.
  6. Edit heavily on proposals and manuals, but take it easy on signed articles.
  7. Have good reasons for everything you do.
  8. Learn to reward good writing with a note at the top. Recognition will breed more good work.
  9. Smile. Be pleasant, agreeable, accommodating, and helpful. (p. 145)
The "Triage" chapter starts with an old table that came into use from the Jet Propulsion Lab (JPL):
  1. Coordination (production expediting)
  2. Policy (confirming to house style)
  3. Integrity (making sure it's all there)
  4. Screening (minimal language editing)
  5. Copy clarification (for typesetter)
  6. Format edit (headings, footings, columns, etc.)
  7. Mechanical style edit (consistency check)
  8. Language edit (clarity, concession)
  9. Substantive edit (logic, organization)
That's more granularity to the editing process than is usually seen, and it isn't clear whether this is an even continuum from coordination to substantive edits. In the end, it may not even matter. "When it gets right down to it, the depth of the editing depends almost entirely on the trust between author and editor."

Unfortunately, that often means that bad writers can slip through the cracks. "If you ask an author if he wants a thorough edit or just a bindery check, he will opt for the latter, especially if he is a poor writer. Thus, the worst writers get the least editing." (p. 121)

The meat of the book is reserved for hard-core editing practices, and includes enough grammar rules and punctuation guidelines to satisfy all comers. You'll read up on the Fox Index and Readability Principles, understand how to battle redundant modifiers and smothered verbs, and more.

In this way, the authors handle the tools and skills required to mark up another person's copy, then they cover the Zen of editing technical documents, with the lengthy list of advice for handling authors. This makes the book a complete package. It may be getting a little long in the tooth-it was printed in 1995, which is a long time ago in Web years. The book could stand an update to accommodate the quirky world of web pages that look like ransom notes and marketing speak invading the technical realm. Still, it's a great addition to the lonely world of The Order of the Red Pen.

Garret Romaine is a technical publications lead at Pixelworks, Inc. in Tualatin, OR. He is a past president of the Willamette Valley Chapter and can be reached at garretr@pixelworks.com.


Copyright © 2001 Willamette Valley Chapter. All rights reserved.
Revised: April 2001
STCWVC Home Page    Newsletter Contents