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.
Documentation-as-Code
Softwarearchitekturdokumentation praktisch mit Entwicklerwerkzeugen umsetzen - 2 Tage
Dates and Booking
Description
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
Your Benefits
Moderne, effektive und pragmatische Dokumentation der Softwarearchitektur
Einfache Erstellung und Pflege dank leichtgewichtiger Werkzeuge
Optisch ansprechende und leicht zu pflegende Diagramme und Grafiken
Zielgruppenorientiertes Kombinieren von redundanzfreien und generierten Inhalten
Importieren von Informationen aus bestehenden Quellen und Export in Dokumenten-Management-Systeme
Einbinden der Dokumentationserstellung in die kollaborativen Softwareentwicklungsprozesse
Kontinuierliche Auslieferung der stets aktuellen Dokumentation
Austausch zu aktuellen Trends bei den Tools und den Markup-Sprachen
Audience
Dieser interaktive Workshop richtet sich an alle, die Softwarelösungen qualitativ hochwertig dokumentieren wollen und einen technischen Background haben. Also Entwickler:innen, Architekt:innen und auch Produktverantwortliche. Die Teilnehmenden haben bereits praktische Erfahrungen in IT-Projekten gesammelt. Kenntnisse in einer bestimmten Technologie oder Programmiersprache sind nicht erforderlich.
Training Objectives
Einsetzen leichtgewichtiger Text- und Grafikformate, nahtloses Einbinden in den Entwickler-Werkzeugkasten
Einbinden der Dokumentationserstellung in das automatisierte Build-Management
Erstellen aussagekräftiger Diagramme und Grafiken
Regelmäßiges Ausgeben der Dokumentation, orientiert an Zielgruppen und in flexiblen Formaten
Vermeiden von Redundanzen, Generieren von Dokumentation aus dem Quellcode und Modellen
Einsammeln und Einarbeiten von Feedback sowie nahtlose Integration in die Software-Entwicklungsprozesse
Your Trainers
Falk Sippach
Architekturbewertungen, Java Experte