Jean Hollis Weber
Too many technical editors focus on the details and don’t pay enough attention to the bigger picture when reviewing documents.
Is this statement true, or do writers, managers and others only perceive it to be true? If it’s true, why does this happen? If it isn’t true, why do so many people think that’s what editors do?
I think the statement is true (notice that I said “too many” technical editors, not “all” or even “most”), and that it’s a problem for editors in general. Because some editors focus — or appear to focus — mainly on details (spelling, punctuation, formal grammar, word choices), other people are left with the impression that all editors are pedantic, nit-picky people who are more interested in correcting mistakes and enforcing rules than in helping writers create the best document for the intended audience.
Am I saying that the details aren’t important? No, certainly not! I’m saying that the details are only part — often a rather small part — of what a technical editor can and should be reviewing. After all, a document can be correctly spelled and punctuated, be grammatically correct, and use only approved terminology selected for the target audience, and yet it doesn’t serve the needs of that audience.
Why does this narrow editorial focus occur, or appear to occur? I can think of several reasons, some to do with editors themselves and others associated with the perceptions and priorities of managers, writers, and other clients.
Many technical editors are in one of these groups:
• They don’t believe they can contribute substantively because they haven’t been trained in substantive editing (also called comprehensive or developmental editing) or they aren’t sufficiently familiar with the subject matter they’re editing.
• They’re more comfortable enforcing rules than making suggestions and then dealing with writers and others who may not appreciate those suggestions.
• They know they can contribute substantively, but they don’t have time — or aren’t allowed — to do so.
• They lack the basic skills to do a good job of copy editing, so they never get a chance to go beyond that stage, even though they might be very good at substantive editing (the skills required are quite different).
Many managers, writers, and other clients believe one or more of the following statements; you can probably think of others.
• Editors do only the picky things, not more substantive evaluation.
• It’s not an editor’s job to substantially revise a writer’s work.
• Substantive editing takes too long and costs too much.
• Editing is done after the manuscript is written, leaving insufficient time to change anything major that an editor might find.
Can we, as editors, do anything to overcome these beliefs and attitudes? Certainly, if the problem is at our end, we can seek training in both editing skills and negotiating and other skills for dealing with people.
We need to make sure that we know how to add value through substantive editing, if we’re going to put ourselves forward to do it. That often means we need to learn a lot more about technical topics, not just writing and editing issues. Indeed, we may need to know almost as much about the topic as do the writers we edit. The main difference is that we should come from the audience’s point of view more than from the technical side. For example, if we’re editing documents aimed at accountants, we need to know something about accounting, so we can tell whether the writing is pitched at the right level, uses appropriate concepts, is organized into tasks that accountants would do, and so on.
If the problem is with others’ perceptions, we can point out the considerable value we can add by substantive editing as well as copy editing. (Indeed, we can point out that copy editing can and should include more than it often does.)
We need to counteract the impression of an editorial focus on minutia that one gets from reading some of the exchanges on the Technical Writers’ list (www.raycomm.com/techwhirl), among others. The impression may be false, but it’s a common one. Reading the Copyeditors’ list (http://listserv.indiana.edu/archives/copyediting-l.html) or the list associated with this SIG (http://lists.stc.org/cgi-bin/lyris.pl?enter=stctesig-L) gives a better picture of the range of editorial work, but our clients, managers, writers, and other co-workers are less likely to read those lists. (I find this quite ironic, since editors’ lists are quite appropriate places to discuss minutia as well as the bigger picture.)
To help us make our points, we need good examples that are meaningful to the people we’re trying to convince. Our case is always stronger when we are perceived to be presenting facts, not just opinions.
Some authoritative sources on this issue include Don Bush (who writes the “Friendly Editor” column in the STC’s newsletter Intercom and with Charles P. Campbell wrote a book titled How to Edit Technical Documents, 1995, ISBN 089774870) and Bruce Byfield (see “Tech Writers, Grammar, and the Prescriptive Attitude” on the Techwhirl Web site, www.raycomm.com/techwhirl/magazine/writing/grammar.html). Carolyn Rude (author of Technical Editing, third edition, Longman, 2001, ISBN 020533556X) and Judith A. Tarutz (author of Technical Editing, The Practical Guide for Editors and Writers, Addison-Wesley, 1992, ISBN 0201563568) emphasize both details and the bigger picture. No doubt many other editors say the same.
Jean is a technical editing consultant based in Australia. She has more than 25 years of editing experience in scientific, engineering, computing, and other high-tech fields. Jean maintains the Technical Editors’ Eyrie Web site (www.jeanweber.com). You can reach her at jean@jeanweber.com.