Hitchhiker's Guide to Docs-as-Code
Eine Kolumne im JavaMagazin von Ralf D. Müller und Dr. Gernot Starke über moderne technische Dokumentation mit dem Docs-as-Code-Ansatz.
In dieser Artikelserie zeigen wir, wie man Dokumentation wie Code behandelt: mit denselben Werkzeugen, Prozessen und der gleichen Sorgfalt. Von den Grundlagen mit AsciiDoc über Build-Automatisierung bis hin zu professionellem PDF-Output.
Alle Folgen
Nenn' mich einfach Doktor
Einführung in AsciiDoc und die Grundidee von Docs-as-Code. Warum Dokumentation wie Code behandelt werden sollte.
Artikel lesen →Modulare Dokumentationen erstellen
Wie man große Dokumentationen in handhabbare Module aufteilt und wiederverwendbare Bausteine erstellt.
Artikel lesen →Des Doktors neue Kleider
Styling und Formatierung von AsciiDoc-Dokumenten. Wie man professionell aussehende Dokumente erstellt.
Artikel lesen →Diagramme, jetzt wird modelliert
Integration von Diagrammen in die Dokumentation. PlantUML, draw.io und andere Tools für Architekturdiagramme.
Artikel lesen →Beautiful Code
Syntax-Highlighting und Code-Dokumentation. Wie man Quellcode schön und lesbar in Dokumente einbettet.
Artikel lesen →Build-Magie
Automatisierung mit Gradle und docToolchain. Wie man den Dokumentations-Build in die CI/CD-Pipeline integriert.
Artikel lesen →PDF-Output
Professionelle PDF-Generierung aus AsciiDoc. Layouts, Fonts und Druckoptimierung.
Artikel lesen →Websites mit Asciidoctor
Von AsciiDoc zur Website. Statische Site-Generatoren und Online-Dokumentation.
Artikel lesen →Weitere Artikel auf Informatik Aktuell
Zusätzliche Artikel gemeinsam mit Dr. Gernot Starke
Docs-as-Code – Die Grundlagen
Dokumentation mit robusten Open-Source-Werkzeugen in die Softwareentwicklung integrieren.
Artikel lesen →Docs-as-Code – Die Werkzeuge
Dokumentation als Plain Text verwalten und das Open-Source-Tool docToolchain einsetzen.
Artikel lesen →Docs-as-Code – Alles unter einem Dach
Verschiedene Teile der Docs-as-Code-Dokumentation mit jBake zusammenführen.
Artikel lesen →