Loading content
Documentation-as-Code integrates technical documentation into the software development process: text-based content under version control, automated builds and review workflows.
Documentation-as-Code treats technical documentation as part of the software development workflow: content in text files under version control, automated builds, reviews and continuous delivery of docs. It creates reproducible, collaborative processes, improves traceability and integrates documentation into CI/CD pipelines for developer teams. Tooling like Sphinx, MkDocs or AsciiDoc is commonly used.
share of API endpoints or modules with associated documentation.
time from change to published documentation in production.
share of broken or dead links in published documentation.
documentation as reStructuredText in repo, CI builds HTML on ReadTheDocs.
Markdown sources in Git, automatic deploy to static hosting platform.
OpenAPI spec in repo, generator produces consistent reference pages in the build.
evaluate: choose format, generator and hosting.
adapt repository structure and add templates.
build CI pipeline: automate linting, build and deploy.
publish contribution guide and style guide.