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

Docs-as-Code: Änderungen gemeinsam prüfen

Bei Docs-as-Code liegen Dokumente in bearbeitbaren Textdateien. Änderungen werden versioniert, geprüft und anschließend in ein lesbares Ausgabeformat überführt. Der Nutzen zeigt sich besonders dann, wenn Dokumentation und Software häufig gemeinsam geändert werden.

Beispiel: Eine geänderte Konfigurationsoption

Ein Änderungsvorschlag enthält den neuen Programmcode, die überarbeitete Erklärung und ein passendes Beispiel. Die prüfende Person sieht zusammen, ob Beschreibung und Verhalten übereinstimmen. Ein Build kontrolliert, ob sich das Buch erzeugen lässt. Zusätzliche Prüfungen können fehlende Links oder abweichende Begriffe melden; fachliche Richtigkeit folgt daraus nicht automatisch.

Wiederholbare Veröffentlichung

Für verlässliche Ergebnisse müssen Werkzeugversionen, Erweiterungen und benötigte Dateien festgelegt werden. Allein die Verwendung von Git oder Markdown macht einen Build weder deterministisch noch offlinefähig. Auch Barrierefreiheit hängt von Inhalt, Struktur, Theme und Ausgabe ab.

KI-Werkzeuge können Änderungen vorbereiten. Ihre Ergebnisse werden als Textänderungen geprüft, bevor der eigentliche Publikationslauf beginnt. Dadurch bleibt nachvollziehbar, welcher Text veröffentlicht wurde.

Aufbau dieses Buches

Die Inhalte liegen als Markdown vor. SUMMARY.md ordnet die Kapitel, book.toml konfiguriert mdBook. Für eine Änderung werden Inhalt und Querverweise geprüft, danach wird die HTML-Ausgabe gebaut und kontrolliert.

Unterkategorien: gefilterte Softwareauswahl

Open-Source-Auswahl nach Reifegrad

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

Redaktioneller Stand: 27. September 2026. Auswahl nach der gemeinsamen Bewertungsmethode. Die Reihenfolge priorisiert Reife und anschließend die Eignung für diese Kategorie.

RangSoftwareLizenz des KernsReifegradSchwerpunktPassender Speicherweg und Nachweis
1SphinxBSD-2-ClauseSehr hochUmfangreiche technische DokumentationDateien: reStructuredText-/Markdown-Quellen und HTML-Dateien
2DoxygenGPL-2.0Sehr hochAutomatisierte API-ReferenzenDateien: Quellcode-/Textdateien und generierte Referenzen
3AsciidoctorMITSehr hochStrukturierte technische Texte in AsciiDocDateien: AsciiDoc-Quellen und Ausgabedateien
4DocusaurusMITHochDokumentationsportale mit KomponentenDateien: Markdown-/MDX-Dateien
5mdBookMPL-2.0HochVersionierte Markdown-HandbücherDateien: Markdown- und HTML-Dateien

1. Sphinx

Begründung: Querverweise, API-Erweiterungen und mehrere Ausgabeformate bilden eine belastbare Publikationsbasis.

Einordnung: Erweiterungen müssen im Build aufeinander abgestimmt sein.

Offizielle Grundlage: Sphinx.

2. Doxygen

Begründung: Langjährig eingesetzter Generator mit umfassendem Konfigurations- und Referenzhandbuch.

Einordnung: Ein vollständiger Review- und Veröffentlichungsprozess kommt aus der Umgebung.

Offizielle Grundlage: Doxygen.

3. Asciidoctor

Begründung: Seit 2012 entwickelte Verarbeitungskette mit dokumentierter Nutzung, Tests und mehreren Ausgabewegen.

Einordnung: Für ein vollständiges Portal werden zusätzliche Struktur- und Build-Bausteine benötigt.

Offizielle Grundlage: Asciidoctor.

4. Docusaurus

Begründung: Etabliertes Dokumentationsframework mit dokumentierter Entwicklung und Sicherheitsrichtlinie.

Einordnung: Node.js- und React-Abhängigkeiten gehören zur laufenden Pflege.

Offizielle Grundlage: Docusaurus.

5. mdBook

Begründung: Dokumentierter, fokussierter Build-Prozess und einfache Navigation über SUMMARY.md.

Einordnung: Mehrere Produktversionen und komplexe Portale benötigen zusätzliche Organisation.

Offizielle Grundlage: mdBook.