Drafting Documentation

This chapter helps you set yourself up for writing success by choosing writing tools that you’re comfortable and familiar with. The tool chain that you use for writing code likely works great for documentation as well. Start by defining the audience, purpose, and pattern of the document. The goal of the document should be the title of your document. Create an outline for your document and flesh it out using headers, paragraphs, lists, and callouts. Fill in the details of your plan from Chapter 2. Readers will skim your document, so make information easy to find by stating the most important information first and breaking up content for your readers. Create and use templates if you’re making multiple similar documents to create consistent documentation.