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

Strukturierte Textauszeichnung und API-Dokumentation

Übergeordnete Kategorie: Docs-as-Code

Werkzeuge für strukturierten Text, Quellcode-Referenzen und reproduzierbare Ausgabe.

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
1DoxygenGPL-2.0Sehr hochLangjährig eingesetzt; umfassendes Referenzhandbuch.Dateien: Quellcode-/Textdateien und generierte Referenzen
2SphinxBSD-2-ClauseSehr hochUmfangreiches Handbuch und ausgebautes Erweiterungssystem.Dateien: reStructuredText-/Markdown-Quellen und HTML-Dateien
3AsciidoctorMITSehr hochDokumentierte Verarbeitungskette mit Tests.Dateien: AsciiDoc-Quellen und Ausgabedateien
4PandocGPL-2.0-or-laterSehr hochBreite Formatunterstützung und dokumentierte Entwicklung.Dateien: Markup- und Dokumentdateien
5JekyllMITSehr hochLangjähriger Generator mit dokumentiertem Ruby-Ökosystem.Dateien: Markdown-/HTML-Dateien und Templates

Einsatz und Abgrenzung

Die Liste nennt heutige Werkzeuge für das Architekturprinzip. Sie ist keine Behauptung, alle Projekte seien bereits in der historischen Vorläufergeneration entstanden.

  • Doxygen: Etablierter Standard zur Extraktion strukturierter Schnittstellenreferenzen direkt aus Quellcode-Kommentaren (C++, Java, C).
  • Sphinx: Führend bei semantischen Querverweisen in reStructuredText und MyST-Markdown mit präziser Typprüfung für Programmiersprachen-Domänen.
  • Asciidoctor: Leistungsfähige AsciiDoc-Verarbeitung für technische Dokumente mit modularen Dateieinbindungen (include), Callouts und bedingter Kompilierung.
  • Pandoc: Dient als universelle Syntax-Brücke zur formatverlustarmen Transformation zwischen unterschiedlichen Auszeichnungssprachen.
  • Jekyll: Kombiniert Markdown-Texte mit strukturierten YAML-Frontmatter-Metadaten für templategestützte Publikationsprozesse.