Chapter 14: Documentation processes and methodology
- Overview
- 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
Topic 1 of 15
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.
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, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.
If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.
Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.