Finished up the section on documentation processes (for now)

by Tom Johnson on Nov 26, 2020 •
categories: api-doc • apidoc-site-updates

• DX content strategy with developer portals

• Processes for managing large documentation projects

• Processes for managing small documentation requests

• Processes for managing SDK releases

• Documentation kickoff meeting and product demo

• Processes for reviewing documentation

• Processes for maintaining existing documentation

• Processes for collecting feedback post-release

• Processes for external contributors

• Processes for changing internal doc culture

While not comprehensive, these processes elaborate on the original DX content strategy that I originally surfaced. I realize that my perspective on these processes is probably shaped by my current company, experience, tools, product domain, and so on. However, I think these topics cover many aspects common to any documentation group. I’m sure I could add another dozen process topics, as there many facets to managing documentation on a developer portal. This list of 10 articles is a good starting point for thinking about and developing your own documentation processes.

Buy me a coffee

Tweet

About Tom Johnson

I'm a technical writer / API doc specialist based in the Seattle area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.

Comments

Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 6,100+ subscribers. (See email archive here.)