Basiswissen Softwarearchitektur, 3rd Edition

6 Dokumentation

A documentation package for a Software architecture is composed of one or more view documents and documentation that explains how the views relate to one another, introduces the package to its readers, and guides them through it.

Paul Clements [Clements03]

Damit das Wissen über die Architektur Ihres Systems nicht verloren geht, müssen Sie es dokumentieren. Aus dieser Motivation und den Zielen für die Erstellung einer Architektur, wie in Abschnitt 1.2.2 dargestellt, lassen sich die Anforderungen an eine Dokumentation ableiten: Dies sind insbesondere die Strukturierung der notwendigen Systeminformationen und der Fokus auf die potenziellen Leser. Das Kapitel gibt einen Überblick über alle wichtigen Aspekte der Dokumentation und stellt ...