Dokumentation hilft, Ideen zu kommunizieren und uns auch noch nach Wochen an Lösungskonzepte zu erinnern. Trotzdem wird sie häufig stiefmütterlich behandelt und wir treffen viel häufiger auf tolle Architekturen als auf tolle Architekturdokumentationen. In diesem Vortrag berichten wir von unseren Erfahrungen rund um Architekturdokumentation. Wir fassen 7 Anti-Patterns zusammen und geben Tipps, wie jede:r die Architekturdokumentation verbessern kann. Unsere Tipps sind unabhängig vom verwendeten Vorgehen und kombinierbar mit Templates wie arc42.

Zielpublikum: Entwickler:innen, Software-Ingenieur:innen, Architekt:innen
Voraussetzungen: Keine
Schwierigkeitsgrad: Fortgeschritten

Extended Abstract
Zugegeben, kaum jemand fällt beim Thema Architektur-Dokumentation vor Begeisterung vom Stuhl, aber spätestens bei mittelgroßen Systemen geht es nicht mehr ohne. Jede:r kennt die Fragen: „Wie hatten wir uns da entschieden?“ oder „Warum wollten wir das so machen?“ Dokumentation hilft uns, Software-Architektur präziser zu machen, Ideen zu kommunizieren und uns auch noch nach Wochen an Lösungskonzepte zu erinnern.
Aber obwohl Architekturdokumentation eine so wichtige Rolle im Entwicklungsprozess einnimmt, wird sie ganz häufig eher stiefmütterlich behandelt. In unseren Projekten treffen wir viel häufiger auf tolle Architekturen als auf tolle Architekturdokumentationen. Dabei begegnen uns immer wieder die gleichen Defizite: Überbetonung von technischen Aspekten, keine oder nur unkonkrete Darstellung von Qualitätsattributen oder Vermischung von Lauf- und Entwicklungszeitaspekten sind nur einige Beispiele.
In diesem Vortrag berichten wir von unseren Erfahrungen rund um Architektur-Dokumentation von unterschiedlichsten Systemen und Branchen. Wir fassen 7 Anti-Patterns zusammen und geben Tipps wie jede:r durch einfache Mittel die Architektur-Dokumentation verbessern kann. Unsere Tipps sind unabhängig vom verwendeten Vorgehen und natürlich auch kombinierbar mit Templates wie arc42.