1. I'd Rather Be Writing
2. Learn API Doc
3. Chapter 9: The writing process

Chapter 9: The writing process

Download PDF

The five main steps in the documentation writing process include (1) Planning (creating a doc plan, establishing roles), (2) Gathering information (interviewing engineers, product managers, etc.), (3) Writing (separating content into groups, outlining, scheduling reviews, writing the first draft), (4) Reviewing (reaching out to the right people, incorporating feedback, resolving conflicts), and (5) Publishing (integrating new content, adding metadata, coordinating timing, publicizing releases). This chapter provides practical tips in each writing step, such as recording engineering interviews, bringing questions to review meetings, and publicizing releases through newsletters. Although many other aspects of API documentation might seem more pressing, such as configuring your publishing toolchain, writing is still a core task technical writers do when creating API documentation.

Sections:

• Overview of the writing process
• 1. Planning
• 2. Information gathering
• 3. Writing
• 4. Reviewing
• 5. Publishing