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
Deine Trainer:innen
Ralf D. Müller
Docs-as-Code, Softwaredokumentation
- Documentation-as-Code
- Phantastische Diagramme
- Prompt Engineering für Architekt:innen und Entwickler:innen
Ralf hat in über 25 Jahren in der Softwarebranche seine Fähigkeiten kontinuierlich verbessert und sich vom Softwareentwickler zum erfahrenen Software-Architekten entwickelt. Neben dem Design von Softwarearchitekturen legt er großen Wert auf die klare Kommunikation und Dokumentation seiner Ideen. Mit diesem Ziel vor Augen hat Ralf das Open-Source-Projekt docToolchain ins Leben gerufen, das sich mit der effektiven Dokumentation von Softwarearchitekturen beschäftigt. Er ist auch verantwortlich für die Erstellung der verschiedenen Formate des arc42 Templates. Als CPSA-Advanced-zertifizierter Softwarearchitekt teilt Ralf sein Wissen und seine Erfahrung in Schulungen und Vorträgen, um anderen zu zeigen, wie sie Architekturdokumentation einfach und aktuell halten können. Video: Mehr als Pfeile und Kästchen – Architekturdiagramme im Softwarearchitektur-Stream.