
Vortrag: Embedded Software Engineering Kongress,Sindelfingen 5. Dezember 2012
Dokumentation wird oft als lästige Pflicht angesehen und in vielen Softwareprojekten vernachlässigt. Die Architektur wird manchmal überhaupt nicht beschrieben. Dabei hilft gute Architekturdokumentation dabei, zentrale Ideen im Team und gegenüber anderen Beteiligten zu kommunizieren. In diesem Vortrag arbeite ich zunächst kurz heraus, welche Ziele Sie mit Architekturdokumentation generell verfolgen können. Anschließend stelle ich zentrale und bewährte Zutaten zum Festhalten architekturrelevanter Einflussfaktoren und wichtiger Entscheidungen vor. Ich zeige, wie Sie diese Ergebnisse zusammenstellen und ordnen können. Und ich diskutiere typische Werkzeugoptionen, um die Bestandteile zu erfassen, zu verwalten und zu verbreiten. Anhand der Gegenüberstellung von UML-Werkzeugen und Wikis werden die Stärken und Schwächen typischer Toolketten deutlich. Den Abschluss bilden Hinweise, die Ihnen helfen die häufigsten Fallen im Zusammenhang mit Dokumentation zu entschärfen.