1. I'd Rather Be Writing
2. Docs
3. Chapter 14: Documentation processes and methodology

Chapter 14: Documentation processes and methodology

Download PDF

This chapter dives into project methodologies to manage technical documentation work. For both extensive projects and minor documentation requests, file the requests as bugs and managing them using a Scrum-like methodology, preferably following similar management processes as your engineers. You need to understand your engineering organization’s release cycle process and plug documentation into that cadence so that you can anticipate upcoming documentation needs and orchestrate reviews in time for the releases. Besides working on new requests, you also need a method for maintaining existing documentation and ensuring quality. From SDK releases to kickoff meetings and more, you need processes to follow. To facilitate communication, tech writers should be visible and participate in the activities, forums, and channels around them.

Sections:

• DX content strategy with developer portals
• Following agile scrum with documentation projects
• Managing large documentation projects
• Managing small documentation requests
• Managing SDK releases
• Documentation kickoff meetings and product demos
• Processes for reviewing documentation
• Maintaining existing documentation
• Collecting feedback post-release
• Managing content from external contributors
• Changing internal doc culture
• Sending doc status reports -- a tool for visibility and relationship building
• Broadcasting your meeting notes to influence a wider audience
• Ensuring documentation coverage with each software release

About Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.