Skip to content
Olivier CarrèreTechnical writing practice

CI/CD

Documentation pages on CI/CD (6 pages).

This topic brings together 6 pages across the manual:

3 Concepts2 Tasks1 Reference

  • 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.

  • Delivery

    Concept

    Learning path: 2. Build a documentation process

    Delivery is the final step: validated content reaches its audiences through the format and channel chosen at project definition, from animations and brochures to newsletters, website updates, and printed or PDF guides.

  • 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 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.

  • 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.

  • Validation and quality control

    Concept

    Learning path: 2. Build a documentation process

    Validate technical documentation before delivery: run validation in parallel with writing, track every change request through a CMS workflow or a ticketing system, and use comparison tools to review updates reliably.

All topics