Docs-as-Code nach Ralf D. Müller, dem Ersteller von docToolchain, behandelt Dokumentation wie Code: in Plain-Text-Formaten wie AsciiDoc geschrieben, in Git zusammen mit dem Code verwaltet, über Pull Requests geprüft und von automatisierten Toolchains gebaut. Auch Diagramme entstehen als Code, etwa mit PlantUML, und eine Quelle erzeugt mehrere Ausgabeformate wie HTML und PDF. So bleibt die Dokumentation mit dem Code synchron, den sie beschreibt.

Docs-as-Code according to Ralf D. Müller

Details
Vollständiger Name

Docs-as-Code-Ansatz nach Ralf D. Müller

Kernkonzepte:

Plain-Text-Formate

AsciiDoc, Markdown

Versionskontrolle

Dokumentation in Git zusammen mit Code

Automatisierte Toolchains

Build-Pipelines für Dokumentation

Single Source of Truth

Mehrere Ausgabeformate aus einer Quelle generieren

Diagramme als Code

PlantUML, Mermaid, Graphviz, Kroki

Kontinuierliche Dokumentation

Mit jedem Commit aktualisiert

Entwicklerfreundlich

Dieselben Tools und Workflows wie für Code verwenden

Review-Prozess

Pull Requests für Dokumentationsänderungen

Modulare Dokumentation

Includes und Komposition

Schlüsselvertreter

Ralf D. Müller (docToolchain-Ersteller)

Technischer Stack:

  • AsciiDoc/Asciidoctor

  • docToolchain

  • Gradle-basierte Automatisierung

  • Kroki für Diagramm-Rendering

  • Arc42-Template-Integration

Wann zu verwenden:

  • Technische Dokumentation für Softwareprojekte

  • Wenn Dokumentation mit Code synchron bleiben muss

  • Verteilte Teams, die an Dokumentation zusammenarbeiten

  • Projekte, die mehrere Ausgabeformate erfordern (HTML, PDF, etc.)