Editing Documentation

This chapter discusses how to turn your first draft of content into a finished, edited document. Editing documentation is like testing and refactoring your code, and just as important. It’s important to edit a document in multiple passes to narrow your focus and reduce complexity. Different passes include technical accuracy, completeness, structure, brevity and clarity. Peer reviews are an important part of learning to write better and teaching your peers about your work. When receiving feedback, consider each item of feedback and decide whether to integrate it into your content. You don’t have to accept each piece of feedback, but you should consider it. When giving feedback, follow the rule of plussing: only criticize an idea if you also add a constructive suggestion.