Technical Writing for Software Developers

8

Collaborative Workflows with Automated Documentation Processes

Chapter 6 covered the tools essential for any documentarian to work with the docs-as-code methodology. But you probably started to realize that treating documentation in similar ways to code opens up many more possibilities for automation, standardization, and testing. While the potential for automating aspects of documentation is vast, this chapter focuses on the following:

• Creating more consistent language with style guides and linting
• Maintaining up-to-date images and videos
• Testing code to ensure it works and is up to date

After these three main topics, it also covers some smaller, miscellaneous ideas.

Striking the right balance

While considering documentation automation, ...