Chapter Objectives

Upon completion of this chapter, readers will be able to:

  1. Explain the general procedure for technical editing.
  2. Explain the different levels of edit.
  3. Explain the purposes of style guides and style sheets.
  4. Use copyediting symbols appropriately.
  5. Use proofreading symbols appropriately.

This chapter focuses on editing technical documents. In particular, this chapter will address some of the most common types of technical editing you can do, as well as processes, resources, and techniques you can use.

  • Overview of technical editing
  • General procedure for editing
  • Contracts
  • Levels of edit
  • Editors' resources
  • Strategies for writing comments
  • Strategies for marking up technical materials
  • Hard-copy editing marks
  • Special ideas for editing visual materials
  • Special ideas for editing websites

Overview of technical editing

You may find that technical editing is very different from what you expect. When people hear the word "edit," they think of rewriting an author's words; working with authors on issues such as character plot, and storyline; suggesting the most appropriate word in order to make a manuscript "sing." That's not technical editing.

Instead, technical editing is a highly rhetorical, detail-oriented process of ensuring that specialized information appears so that it is appropriate for end users, and technical editors make informed, thoughtful suggestions for improvement toward that purpose.

Technical editing is a collaborative process with authors, who are often subject-matter experts (SMEs, pronounced "smees"), to check correctness of such things as chemical formulas, specialized terminology, equations, and matchups between textual and visual elements, as well as more traditional aspects of writing.

Technical editing is a recursive process, not a one-and-done routine. Technical editors often review the same materials multiple times and have their edits reviewed before the materials are printed or posted online. Only rarely will technical editors make changes and then publish the materials immediately.

Technical editing covers a surprisingly wide variety of subjects, contexts, and materials. Job ads for technical editors seek people who can comment on—and create new—paper documents, electronic documents, images, visual designs, websites, audio and video files, and multimedia presentations, just to name a few examples.

This chapter will focus on editing text on hard copy, soft copy, and websites, but it will also provide you with concepts and techniques that you can use in graphics-heavy and multimedia editing tasks.