Docs-as-Code according to Ralf D. Müller, the creator of docToolchain, treats documentation like code: written in plain-text formats such as AsciiDoc, kept in Git alongside the code, reviewed through pull requests and built by automated toolchains. Diagrams are written as code too, for example in PlantUML, and one source generates multiple output formats such as HTML and PDF. This keeps the documentation synchronized with the code it describes.
Docs-as-Code according to Ralf D. Müller
Details
- Full Name
-
Docs-as-Code Approach according to Ralf D. Müller
Core Concepts:
- Plain text formats
-
AsciiDoc, Markdown
- Version control
-
Documentation in Git alongside code
- Automated toolchains
-
Build pipelines for documentation
- Single source of truth
-
Generate multiple output formats from one source
- Diagrams as code
-
PlantUML, Mermaid, Graphviz, Kroki
- Continuous documentation
-
Updated with every commit
- Developer-friendly
-
Use same tools and workflows as for code
- Review process
-
Pull requests for documentation changes
- Modular documentation
-
Includes and composition
- Key Proponent
-
Ralf D. Müller (docToolchain creator)
Technical Stack:
-
AsciiDoc/Asciidoctor
-
docToolchain
-
Gradle-based automation
-
Kroki for diagram rendering
-
Arc42 template integration
When to Use:
-
Technical documentation for software projects
-
When documentation needs to stay synchronized with code
-
Distributed teams collaborating on documentation
-
Projects requiring multiple output formats (HTML, PDF, etc.)