„Die Dokumentation von Softwarearchitektur klingt viel zu aufwändig für mein Projekt. Das will mein Kunde nicht bezahlen!“
Unsere Erfahrung aus vielen Projekten mit unterschiedlicher Größe ist, dass der Umfang der Dokumentation angemessen an die Projektgröße erfolgen muss. So kann der Softwarearchitekt entscheiden mit welchem Detailgrad die Bausteine beschrieben werden.
Durch die Nutzung von einem Template, mit dem die Softwarearchitektur unternehmensintern dokumentiert wird, kann eine Dokumentation in kurzer Zeit erstellt werden. Die feste Struktur des Templates ermöglicht einen schnellen Start und es gewährleistet, dass sich der Softwarearchitekt mit allen notwendigen Punkten auseinandersetzt.
Nutzen der Dokumentation von Softwarearchitektur
Der Nutzen der Dokumentation von Softwarearchitektur ist, dass das Wissen nicht nur bei dem Architekten bleibt, der die Architektur erstellt hat. Das Wissen wird an neue Mitarbeiter oder auch externe, zukünftige Architekten vermittelt. In dem Projekt selbst ist die Software-Architektur Dokumentation ein Kommunikationsinstrument für alle Projektbeteiligten. Die Softwarearchitektur-Dokumentation kann als Basis für die Systemanalyse verwendet werden.
Was sollte auf jeden Fall in der Softwarearchitektur Dokumentation stehen?
Die getroffenen Entscheidungen sollten dokumentiert werden. Wichtig ist es, dass auch für andere Architekten nachvollzogen werden kann, aus welchen Gründen eine Entscheidung getroffen wurde. Bewährte, dokumentierte Entscheidungen ermöglichen anderen Architekten in den gleichen Situationen genau so oder ähnlich zu entscheiden. Das Wissen, welches sonst nur der einen Architekten besitzt, steht durch das Dokumentieren für alle zur Verfügung.
Alle relevanten Sichten eines Systems sollten beschrieben werden. Es existieren unterschiedliche Klassifizierungen von Sichten. Eine typische Unterteilung der Sichten für die Architekturdokumentation sind die folgenden Sichten:
- Kontextsicht: Betrachtung des Systems von außen
- Struktursicht: Betrachtung der statischen Struktur des Innenlebens
- Verhaltensicht: Betrachtung des dynamischen Verhaltens des Innenlebens
- Abbildungssicht: Betrachtung der Abbildung auf Artefakte, Prozessoren oder Teams
Zusätzlich sollte eine Beschreibung über das Zusammenspiel der relevanten Schichten existieren. Die Dokumentation sollte die Frage beantworten, wie die Sichten ineinander greifen. Eine Beschreibung des Aufbaus der Architektur sollte dokumentiert werden. Eine Hilfestellung für den Leser sollte soweit notwendig existieren.
Wer gehört zur Zielgruppe des Software-Architektur Dokuments?
Zur Zielgruppe gehören:
- Projektleiter
- Architekt (auch Architekten aus anderen Projekten)
- Entwickler