Skip to content
Olivier CarrèreTechnical writing practice

Docs-as-code

Documentation pages on Docs-as-code (7 pages).

This topic brings together 7 pages across the manual:

3 Concepts2 Tasks2 References

  • Checklist: docs-as-code adoption

    Reference

    Learning path: 5. Build your toolkitChecklists

    A checklist for moving a documentation team onto a docs-as-code workflow - version control, text-based formats, CI/CD, and team readiness.

  • Example: a basic docs-as-code workflow

    Task

    Learning path: 5. Build your toolkitWorked examples

    A worked example of a single documentation change moving from branch to merge under a docs-as-code workflow, mirroring a standard code review flow.

  • Example: a documentation repository structure

    Reference

    Learning path: 5. Build your toolkitWorked examples

    A worked example of how to organize a docs-as-code repository - content by information type, locale-first for translated sites, and a clear separation from tooling.

  • Example: a practical CI/CD pipeline for documentation

    Task

    Learning path: 5. Build your toolkitWorked examples

    A worked example of a documentation CI/CD pipeline - build, link check, search index, and deploy - annotated stage by stage.

  • Git: from file to content

    Concept

    Learning path: 3. Adopt docs-as-codeGit

    Think content rather than files with Git: branches, commits, and diffs for technical documentation make collaboration and version management far simpler and safer.

  • Integrating documentation into development processes

    Concept

    Learning path: 3. Adopt docs-as-code

    Learn why technical documentation should be released, versioned, and quality-controlled alongside the product, using text formats like DocBook, DITA XML, and reStructuredText.

  • Version management systems - rustic but reliable

    Concept

    Learning path: 3. Adopt docs-as-codeGit

    Use Git or Subversion to manage technical documentation like source code: track changes, collaborate with your team, and roll back safely at any time.

All topics