Diese Inhalte wurden mit Unterstützung von Künstlicher Intelligenz erstellt und redaktionell überprüft (Transparenzhinweis gemäß Art. 50 EU AI Act).

Versionierung, Review und automatisierter Build

Übergeordnete Kategorie: Docs-as-Code

Generatoren als Bausteine eines nachvollziehbaren Dokumentationsprozesses.

Open-Source-Auswahl nach Reifegrad

5 Einträge: für den jeweils beschriebenen Speicherumfang ausgewählt.

Redaktioneller Stand: 27. September 2026; Bewertungskriterien und Grenzen gelten auch hier. Die Rangfolge priorisiert Reife und danach die Passung zum Thema.

RangSoftware und offizielle QuelleLizenz des betrachteten KernsReifegradBegründungPassender Speicherweg und Nachweis
1SphinxBSD-2-ClauseSehr hochUmfangreiches Handbuch und ausgebautes Erweiterungssystem.Dateien: reStructuredText-/Markdown-Quellen und HTML-Dateien
2DoxygenGPL-2.0Sehr hochLangjährig eingesetzt; umfassendes Referenzhandbuch.Dateien: Quellcode-/Textdateien und generierte Referenzen
3AsciidoctorMITSehr hochDokumentierte Verarbeitungskette mit Tests.Dateien: AsciiDoc-Quellen und Ausgabedateien
4MkDocsBSD-2-ClauseSehr hochEtablierter Markdown-Generator mit zentraler Konfiguration.Dateien: Markdown-Dateien und YAML-Konfiguration
5mdBookMPL-2.0HochFokussierter Generator mit Benutzerhandbuch.Dateien: Markdown- und HTML-Dateien

Einsatz und Abgrenzung

Git, Review und CI müssen die Generatoren ergänzen. Bewertet werden hier die Dokumentationswerkzeuge, nicht vollständige Hosting- oder CI-Plattformen.

  • Sphinx: Lässt sich über sphinx-build -W deterministisch in CI-Pipelines einbinden, um unvollständige Verweise sofort als Build-Fehler zu stoppen.
  • Doxygen: Ermöglicht automatisierte API-Dokumentationsläufe direkt nach Code-Commits; erfordert Abstimmung mit dem Compiler-Build-System.
  • Asciidoctor: Schnelle, containerfreundliche Pipeline-Ausführung zur gleichzeitigen Erzeugung von HTML5- und PDF-Releases bei neuen Softwareversionen.
  • MkDocs: Ermöglicht über den Schalter --strict automatisierte Prüfungen auf fehlerhafte Links und fehlende Navigationsziele im CI-Lauf.
  • mdBook: Minimaler Ressourcenbedarf und extrem schneller nativer Build; hervorragend für leichtgewichtige GitHub-Pages- und CI-Workflows ohne Laufzeit-Overhead geeignet.