Dokumentations-Pattern Komponente

8Zielgruppe

  • Unternehmen, die komponenten-basierte Entwicklung betreiben und diese dauerhaft dokumentieren möchten.

Vorteile

  • in einem Wiki sind die Komponenten dauerhaft dokumentiert, in Issue Trackern werden Issues in der Regel nach Bearbeitung geschlossen.
  • Komponenten-Dokumentation kann helfen die Übersicht zwischen den Komponenten und ihren Abhängigkeiten zu bewahren.

Dokumentationsnutzung

  • Abruf von Informationen zur Nachvollziehbarkeit von Systemverhalten und  Systemeigenschaften

Dokumentationsvorgänge

Use Case Ereignis Vorgang Akteur Phase
Komponente aktualisieren Issue Documentation Komponentendaten aktualisieren Entwickler, Architekt, Projektmanager Entwicklung
Komponente anlegen Architekturkomponente identifizieren Komponentenobjekt wird  angelegt Entwickler, Architekt, Projektmanager Konzeption

Assoziationen zu anderen Patterns

  • Verwendung in
  • Erweiterungen
    • Umfangreiche Komponenten können in Features gegliedert werden

Struktur

komponente