Docs-as-Code (online) - Ralf D. Müller - Deutsch
Architektur-Dokumentation wird sehr oft stiefmütterlich behandelt. Die Gründe dafür sind vielfältig und unter anderem in der Verwendung unpraktikabler Werkzeuge und Formate zu finden. Beim Docs-as-Code-Ansatz wird Dokumentation wie Quellcode behandelt. Dokumente werden in leichtgewichtigen Text- und Grafikformaten erstellt, nahe beim Sourcecode in beispielsweise Git-Repos abgelegt und versioniert sowie in automatisierten Build-Prozessen verarbeitet. Dieses Seminar zeigt aufbauend auf schlanken Tools und Markup-Sprachen die Erstellung einer möglichst redundanzfreien Dokumentation, die für verschiedene Zielgruppen optimiert und in ansprechenden Formaten kontinuierlich ausgeliefert werden kann.
Agenda
- Einführung in Documentation-as-Code und unser Fallbeispiel
- Ablage in der Versionsverwaltung
- Notwendige Werkzeuge und Integration ins Build-Management
- Einsatz von Markup-Sprachen
- Modularisierung der Dokumentation
- Effektive Erstellung von Diagrammen (PlantUML, Kroki.io, Diagrams.net, …)
- Erzeugung von zielgruppenorientierten Ergebnisformaten
- Einbinden vorhandener Informationen zur Vermeidung von Redundanzen (Quellcode, Modelle, …)
- Weiterführende Themen wie Microsites und Im- und Export-Formate