Atlas › 24 Technical Writing for QA › Documentation as Code☰ Read as one page
Documentation as Code
5.1Treating Docs Like SoftwareThe docs-as-code approach applies software development practices -- version control, code review, continuous integration, automated testing…5.2Why Docs-as-CodeTraditional documentation tools (Google Docs, Confluence, SharePoint) have a fundamental problem: they are disconnected from the codebase…5.3Choosing the Right FormatThe most common format for docs-as-code. Simple, readable as plain text, widely supported.5.4Documentation GeneratorsReact-based static site generator from Meta. Excellent for project documentation with versioning.5.5Test Documentation in the RepoThe most effective place for test documentation is next to the tests themselves.5.6Automating DocumentationAutomated test reports generated by CI/CD pipelines provide up-to-date quality metrics without manual effort.5.7Documentation Review Process- On change: Every documentation change goes through a PR review, just like code - On schedule: Quarterly review of all active…5.8Keeping Docs FreshSet up systems that alert when documentation has not been updated in a defined period:5.9Hands-On Exercise1. Move one piece of test documentation from your wiki into your code repository. Set it up as a Markdown file in the appropriate location…