In this chapter, Barker goes over the essentials to Technical Writing Editing and how that might be different than traditional Editing. However, it also has many similarities.
Barker talks about an in-house style guide for companies editing procedures. It is important to stay consistent throughout the company and not have different departments completing their tasks differently. Consistency is always key. The following are steps for editing software documentation, found on page 270.
English Project guidelines
2. understand types of editing
plan your editing tasks
Develop the appropriate editing forms.
The goals on page 270 also mention the above consistency, but breaks it down to how the user perceives the document and the purposes of the information in the documents. The goals also include applicability to multi or cross-cultural readers, correspondence of tasks and activities in a manual of help system and smooth interaction with editors and writers, along with the rest of the team.
Page 271 has a table regarding four types of editing which include the following:
Managerial
Substantive
CopyProofreading
Most people understand number 1 and 3, but Substantive editing is developmental editing, which means editing language and information (page 272).
Editing takes time
Table 9.2 on page 277 gives estimates on editing a particular document and Substantive editing requires about 6-8 pages an hour, Copy Editing 1-3 and proofreading 5-10 pages per hour. This table also includes activities that are involved with each task such as for Managerial Editing overseeing production, Substantive includes reading drafts and suggesting content, Copyediting includes correcting sentence clarity and structure and Proofreading includes verifying changes against copyedited pages and checking for layout/graphics consistency.
Barker says conducting editing sessions are very important so that there are no distractions while editing. Most people have other projects they are working on and can also easily get distracted by their co-workers. A good set of large earphones and a checklist are all suggestions Barker makes to ensure good editing.
This chapter also includes editing Graphics, which is a part of the Substantive editor’s job.
Writing Vs. Editing is discussed in this chapter because many people combine the two, but there are clearly differences such as
As a writer you work on generating ideas and content and an Editor concentrates on document standards and comparing information. (Page 280 has a more comprehensive listing).
Many Tech Writers have to think about their audience being the world, so Barker provides tips on how to write for them, too.
use active voice
use articles wherever possible
use simple verb tenses
use language consistently
avoid lengthy compound words
use relatively short sentences
Chapter 9 also includes tips on Editing for Translation, problems with editing online systems, and discusses how do you know what’s correct?
Translation Editing includes “checking for characteristics that allow for language to be easily rendered into another language, (Page 292).”
Problems with editing online systems include
Heavy emphasis on editing index, different production process for planning and scheduling, etc. (a more comprehensive list is on page 293).
Constructive Attitudes are important in writing and editing because you will be critiqued and you will have mistakes in your document, it is important to look at it like you need to perfect the document rather than you made all of these mistakes or you think it’s already perfect.
