Möchten Sie mit Ihrem Team teilnehmen? Ab drei Personen profitieren Sie von unseren Gruppenrabatten! Direkt im Shop buchen!

Diagramm oder Doku? Warum nicht beides!

In diesem Vortrag geht es um PlantUML, AsciiDoc und Antora als Single-Source-of-Truth für Softwarearchitektur und deren Dokumentation.

In vielen Softwareprojekten existieren Diagramme und Dokumentationen in verschiedenen Versionen und an unterschiedlichen Orten – oft mit widersprüchlichen Inhalten. Doch was verbessert sich, wenn Architekturdiagramme und die Dokumentation direkt aus einer einzigen Quelle generiert werden?

Der Vortrag zeigt, wie PlantUML nicht nur Diagramme, sondern auch zusätzliche Informationen in speziell formatierten Kommentaren aufnehmen kann. Diese werden herausgeparsed und in AsciiDoc überführt, um eine vollständige und stets aktuelle Dokumentation zu erzeugen. Mit Antora wird das Ganze modularisiert und als konsistentes Wissensportal bereitgestellt.

Anhand eines erfolgreichen PoC im Kundenauftrag demonstriert der Vortrag, wie diese Toolchain in der Praxis funktioniert – inklusive Automatisierung durch GitLab CI. Das Ergebnis: weniger Wartungsaufwand, eine konsistente Dokumentation und immer aktuelle Architekturübersichten.

Speaker

 

Markus Schlichting
Markus Schlichting ist CEO der Karakun AG.

betterCode-Newsletter

Du möchtest über die betterCode() ArchDoc und weitere unserer betterCode()-Events auf dem Laufenden gehalten werden?

 

Anmelden