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.
| Rang | Software und offizielle Quelle | Lizenz des betrachteten Kerns | Reifegrad | Begründung | Passender Speicherweg und Nachweis |
|---|---|---|---|---|---|
| 1 | Sphinx | BSD-2-Clause | Sehr hoch | Umfangreiches Handbuch und ausgebautes Erweiterungssystem. | Dateien: reStructuredText-/Markdown-Quellen und HTML-Dateien |
| 2 | Doxygen | GPL-2.0 | Sehr hoch | Langjährig eingesetzt; umfassendes Referenzhandbuch. | Dateien: Quellcode-/Textdateien und generierte Referenzen |
| 3 | Asciidoctor | MIT | Sehr hoch | Dokumentierte Verarbeitungskette mit Tests. | Dateien: AsciiDoc-Quellen und Ausgabedateien |
| 4 | MkDocs | BSD-2-Clause | Sehr hoch | Etablierter Markdown-Generator mit zentraler Konfiguration. | Dateien: Markdown-Dateien und YAML-Konfiguration |
| 5 | mdBook | MPL-2.0 | Hoch | Fokussierter 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 -Wdeterministisch 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
--strictautomatisierte 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.