Chapter 11. Working With an Editor

Writing computer documentation involves converting raw information from engineers and marketing professionals into a useful, well-written document. The final document often is a result of efforts from the entire publications team, including writer, editor, designer, illustrator, and production coordinator. However, the content of the document is most closely developed through the work of writer and editor.

This chapter discusses the following topics:

• “Technical Editor’s Role” on page 217

• “Editor’s Role in Producing Online Documents” on page 218

• “Types of Editing” on page 218

• “Planning Ahead for Editing” on page 224

• “Submitting a Document for Editing” on page 224

• “Editing Marks” on page ...

Get Read Me First! A Style Guide for the Computer Industry, Third Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.