Project Description

Info-Card

Die 7 (technischen) Sünden der Architekturdokumentation

Veröffentlichung: 14.03.2018
Sprecher: Falk Sippach
Veranstaltungsort: JavaLand 2018

Abstract:
Textverarbeitungsprogramme sind für technische Dokumentation schlecht geeignet, ein Wiki auch nur bedingt. Anhand einiger Fallbeispiele schauen wir uns an, wie man mit Entwicklerwerkzeugen Dokumentation redundanzfrei erstellt und pflegt, wie man sie validiert und in Teilen generieren oder sogar als Regelwerk ausführen kann.
Die resultierenden Dokumente müssen natürlich jederzeit in verschiedenen Formaten und für die jeweiligen Zielgruppen angepasst erzeugt werden können. Ein effizienter Build-Prozess, dazu schlanke Dokumenten- und Grafikformate sowie eine strukturierte Ablage der Quellen inklusive einheitlicher Versionierung, Historisierung und Vergleichbarkeit sind wichtige Komponenten für Continuous Documentation und Documentation as Code.