embarc logo
embarc logo

Lebendige Architekturdokumentation

Folien zum Vortrag von Falk Sippach und Dirk Mahler auf der betterCode ArchDoc 2023

 
 

Lebendige Architekturdokumentation
... mit Docs-as-Code, jQAssistant und jMolecules
Sprecher: Falk Sippach
betterCode ArchDoc 2023
Montag, 26. Juni 2023, 11:45 - 12:30 Uhr
Online
@bettercodeconf #bettercode

Foliendownload (PDF)

Abstract

JUG saxony Day Logo

Es ist kein Mythos, dass eine gute Softwaredokumentation ein Garant für erfolgreichere Softwareprojekte ist. Die Kunst und Herausforderung zugleich ist es jedoch, den Aufwand überschaubar und mit geeigneten Konzepten die Dokumentation lebendig zu halten.

Der Vortrag stellt leichtgewichtige Methoden, Vorlagen und Tools vor, die zum Erstellen einer hochwertigen, sich selbst validierenden Softwaredokumentation eingesetzt werden. Wir schauen uns Ansätze wie Docs-as-Code, leichtgewichtige Textformate, Ablage in der Versionsverwaltung und die Einbettung in die Build- und Review-Prozesse an. Das Sichtbarmachen von Softwarearchitekturkonzepten im Code mit jMolecules und das Einbinden von Software-Analyse-Werkzeugen wie jQAssistant ermöglichen den kontinuierlichen Abgleich der Soll- und Ist-Strukturen und machen die Architekturdokumentation lebendiger.

Weitere Informationen