Library › Book 24 › Documentation-as-Code and Keeping Docs Alive
Documentation-as-Code and Keeping Docs Alive
8.1🔒Treating Documentation Like SoftwareThe docs-as-code approach applies software development practices -- version control, code review, continuous integration, automated testing…
8.2🔒Why Docs-as-Code MattersTraditional documentation tools (Google Docs, Confluence, SharePoint) have a fundamental problem: they are disconnected from the codebase…
8.3🔒Choosing the Right FormatThe most common format for docs-as-code. Simple, readable as plain text, widely supported.
8.4🔒Documentation Tools and PlatformsPython-based, simple, fast. The Material theme adds a polished UI with excellent search.
8.5🔒Co-Locating Test Docs with Test CodeThe most effective place for test documentation is next to the tests themselves. When documentation lives in the same repository as the…
8.6🔒Automating Documentation QualityAutomated checks keep documentation quality high without manual effort. Add these checks to your CI pipeline so that documentation quality…
8.7🔒Documentation Review Process
8.8🔒Keeping Docs Alive: The Ownership ModelEvery document should have a designated owner. The owner is not necessarily the author -- they are the person responsible for keeping the…
8.9🔒Collaborative DocumentationQA documentation is not a solo activity. The best documentation comes from collaboration between people with different perspectives.
8.10🔒Career Translation- Implemented a docs-as-code pipeline using MkDocs, GitHub Actions, and markdownlint, integrating documentation linting, link checking, and…
8.11🔒Q&AInterview Depth CheckPrompt: Your team currently stores all QA documentation in Confluence, but the engineering team uses GitHub for everything else…