License to Edit: Techniques for Technical Editing Success

By Ann Marie Queeney

The exciting exploits of James Bond may seem far removed from the field of technical editing. However, after reading a book titled, The Man with the Golden Typewriter: James Bond’s Letters I recognized that Ian Fleming––the creator of the iconic spy series––was a disciplined writer whose commitment to clear, sharp writing and accuracy shares many similarities with good technical editing practices.

This article draws upon the mentioned book’s witty and insightful letters between Fleming and his editing team at Jonathan Cape (his publisher), friends, and Bond fans to discuss good editing practices. 

Technical Accuracy

Editing for technical accuracy often involves the confirmation of definitive, clear-cut information, as exemplified in a letter to Fleming from his friend and English playwright Noel Coward.

Coward wrote regarding an error in Dr. No (May 6, 1958):

“. . . but what I will neither accept nor forgive is the highly inaccurate statement that when it is eleven A.M. in Jamaica, it is six A.M. in dear old England.” (p. 187)

Common examples include inaccurate measurement conversions (English to metric, Fahrenheit to Celsius, and time zones) and decimal placement. Technical editors can confirm content accuracy by referring to an official resource or performing the calculation.

Editing for technical accuracy also involves reviewing content based on context, experience, or subject matter expertise.

Daniel George, editor, commented in Moonraker (June 4, 1954)

“ I’m rather dubious about the use of ‘mild steel’ for the engine. . . . If there’s a technical reason for this strange choice it isn’t made clear. Or if it is, I’ve stupidly missed it.” (pp. 60-61)

Common examples involve inappropriate use of materials or equipment and process accuracy errors (incorrect order or missing steps).

As a technical editor in the medical device field, I follow George’s approach of identifying discrepancies and relying on the author or subject matter experts to assess the content’s accuracy and make the necessary corrections.

Technical editors can strengthen their analytical skills by learning more about their company’s industry, regulations, products, goals, and other relevant topics. Look for learning opportunities outside of your immediate responsibilities. I increased my knowledge of FDA regulations by becoming a certified lead internal auditor.

Consistency

Mrs. R. J. Frewin, an observant Bond fan, noted the following in Fleming’s novels (date not given):

“. . . c) the method for contacting head office seemed to vary; d) Bond took his coffee now black, now white; . . . and f) some of Fleming’s dates didn’t work.” (p. 245)

Fleming replied to Mrs. Frewin (October 13, 1960):

“. . . c) For security reasons the regulations for contacting headquarters are changed from time to time. d) Bond only takes cream with his coffee at breakfast time. . . . f) Yours also truly puzzled and I must talk to Bond about this.” (p. 246)

While Fleming’s reply is entertaining, consistency errors in technical documents could result in injury, process errors, legal issues, or other serious consequences. Inconsistencies also produce inaccurate electronic search results, which impede an audience’s understanding and use of the content.

Common examples include inconsistent date format, titles (job, company, government agency), product identification, locations, and requirements.

Technical editors can identify inconsistencies by using an editing software product or electronic search functionality. When performing an electronic search, it is important to locate all instances of an item. Search from specific (for example, quality systems specialist) to general (quality specialist, quality), and include abbreviations in your search (QS).

In addition, up-to-date style guides and other official sources (such as a government website) are valuable resources.

Content

Finally, the appropriate level of detail and content placement often challenges writers and editors.

 William Plomer, wrote about this topic in Goldfinger (June 28, 1958):

“Also, p. 111 Colonel is a fearful bore. Do we need him at all? And, if so, could we have his lectures shortened or omitted?” (p. 200)

Plomer wondered if this particular character was necessary for the plot as he was slowing down the book’s pace. The technical document counterpart is need-to-know vs. nice-to-know information.

Consider the following two questions when editing:

  1. Is the information required for the audience’s understanding?
    Remove the information and reread it. Is the document still clear?
    If available, ask a member of your document’s audience to read the information.

  2. Can the information be altered?
    If the information is required, determine if it is better suited in another format (such as a table or graph) or another location (such as an appendix).

By focusing on editing for technical accuracy, consistency, and appropriate level of detail and placement of content, you too can be granted a license to edit!

References

Fleming, Fergus, ed. The Man with the Golden Typewriter: Ian Fleming’s James Bond Letters (New York, NY: Bloomsbury USA), 2015.

Ann Marie Queeney is a director on the STC board and a member of the Technical Editing and Policies and Procedures SIGs. She is the owner of A.M. Queeney, LLC a consulting business specializing in procedures and other process documents used in the healthcare industry. She is available for webinar and in-person training on a variety of technical communication topics.

Leave a Reply