Content Review and Editing

Editing is a vital part of the documentation process. All content should be peer reviewed by at least one other team member. Review the Editing Checklists as a framework for peer reviews.

Developmental versus Line Editing

Developmental editing looks at the big picture in a piece of writing. When doing a developmental edit, evaluate and critique the piece of writing as a whole. This is the time to suggest additions, deletions, or revisions to the content.

Your goals during this phase of editing is to make sure the piece of writing is:

• Well-organized

• Appropriate in tone, style, and format for its audience

• Clear and articulate

• Consistent in its approach

• Accessible for all readers

Line editing looks at the smaller details in a piece of writing. When doing a line edit, your job is to make sure you're putting out the best quality product possible. You should go over every sentence, checking for:

• Spelling

• Grammar

• Punctuation

• Word usage

• Proper heading structure

• Run-on sentences

• Accessible format

• Unnatural phrasing

Editing Checklists

The Editing Checklists do not cover every single thing you should look for when editing a piece of writing, but should give you a framework from which to start. The checklist is a living document, so feel free to suggest additions if you notice something is missing.

Peer Review

Content should be peer reviewed by at least one other person for a final check. This is a really helpful and best practice that will benefit your writing long term. Use the Editing Checklists to help you make sure you're doing a thorough job reviewing and suggesting edits to your coworkers.

Don't be afraid to ask questions! Asking questions about other people's writing and answering questions about your own is mutually beneficial; even if you think you already know the answer, articulating it often helps clarify things or bring up new points you hadn't thought about.