methodatlas
Playbook

Architekturdokumentation aufbauen

Von verstreutem Architekturwissen zu Views, Entscheidungen und kommunizierbarer Dokumentation.

Ergebnis

Eine lebende Architekturdokumentation mit Views, Rationale, Kommunikationsplan und Pflegeverantwortung.

Am Ende hast du

Architecture DocumentC4 DiagramsArchitecture ViewsCommunication Canvas

Entscheidungspunkt

Du kannst entscheiden, welche Architekturinformationen verbindlich dokumentiert, gepflegt und kommuniziert werden.

Nächster Schritt

Dokumentationsstruktur veröffentlichen, Pflegeowner setzen und Review-Rhythmus etablieren.

Ideal für

  • Onboarding
  • Architecture Reviews
  • Systeme mit gewachsener Komplexität

Nicht gut für

  • Wegwerfprototypen
  • Dokumentation ohne Wartungsowner
Vorbereitung

Was vor dem Start klar sein sollte

Rollen

  • Architekt oder Tech Lead
  • System- und Teamverantwortliche
  • Zielgruppen der Dokumentation

Inputs

  • bestehende Architekturartefakte
  • bekannte Pain Points im Onboarding oder Review
  • wichtige Systeme, Entscheidungen und Stakeholder

Setup

  • Dokumentationsziel klären
  • Ablage und Pflegeprozess wählen
  • wichtigste Zielgruppen und Fragen sammeln
Ablauf

Methodenpfad

4 Methoden
  1. 1ArchitectureArchitecture Document

    arc42

    Welche Architektur-Entscheidungen, Strukturen und Qualitätsmerkmale braucht der Leser, um das System verstehen, betreiben und weiterentwickeln zu können?

    Warum dieser Schritt?

    arc42 liefert eine robuste Struktur für Ziele, Kontext, Bausteine, Laufzeit, Entscheidungen und Risiken.

    Die Struktur wird anschließend mit geeigneten Architekturdiagrammen konkretisiert.

  2. 2ArchitectureC4 Diagrams

    C4 Model

    Auf welcher Abstraktionsebene welcher Leser welche Architektur-Information aus dem Diagramm zieht?

    Warum dieser Schritt?

    Das C4 Model macht System, Container und Components auf unterschiedlichen Abstraktionsebenen verständlich.

    Die Diagramme werden danach um stakeholderrelevante Sichten ergänzt.

  3. 3ArchitectureArchitecture Views

    Views and Beyond

    Welche Views adressieren welche Stakeholder mit welchem Quality-Anliegen, und welche Cross-View-Information bindet sie zu einem konsistenten Bild?

    Warum dieser Schritt?

    Views and Beyond hilft, Architekturinformationen aus Sicht verschiedener Stakeholder und Qualitätsfragen zu organisieren.

    Die Sichten brauchen anschließend eine passende Kommunikationsstrategie.

  4. 4ArchitectureCommunication Canvas

    Architecture Communication Canvas

    Welche Architekturbotschaft erreicht welche Zielgruppe in welchem Format, sodass Entscheidungen, Akzeptanz oder Umsetzung gefoerdert werden?

    Warum dieser Schritt?

    Der Architecture Communication Canvas verbindet Publikum, Botschaft, Artefakt und Kommunikationsziel.

    Die Kommunikationsplanung macht aus Dokumentation ein nutzbares, gepflegtes Arbeitsmittel.

Abschlusskriterien
Vorlagen

Artefakte für dieses Playbook

Die Artefakte bleiben zugeklappt, bis du sie wirklich brauchst.

MarkdownVorlage anzeigen

arc42 Arbeitsvorlage

Kompakte Arbeitsvorlage für arc42 mit Kontext, Input, Ergebnisartefakten und nächstem Schritt.

# arc42 Arbeitsvorlage

## Ziel

Pragmatisches Template für strukturierte, lebendige Softwarearchitektur-Dokumentation.

## Kontext

Wann und wofür nutzen wir diese Methode?

## Input

Welche Daten, Beobachtungen, Entscheidungen oder Materialien liegen vor?

## Durchführung

Kurze Notizen entlang des Runsheets.

## Ergebnisartefakte
- Architecture Document:
- Context View:
- Runtime View:
- Deployment View:

## Annahmen und offene Fragen

- ...

## Entscheidung / Nächster Schritt

Owner, Datum und Erfolgssignal.
CanvasVorlage anzeigen

C4 Model Arbeitsvorlage

Kompakte Arbeitsvorlage für C4 Model mit Kontext, Input, Ergebnisartefakten und nächstem Schritt.

# C4 Model Canvas

## Kontext

Wofür wird die Methode eingesetzt?

## Kernfrage

Welche Frage soll am Ende beantwortet sein?

## Input

Welche Daten, Beobachtungen oder Materialien liegen vor?

## Arbeitsfläche

- Bereich 1:
- Bereich 2:
- Bereich 3:
- Beziehungen / Muster:

## Ergebnisartefakte
- Context Diagram:
- Container Diagram:
- Component Diagram:

## Offene Fragen

- ...

## Nächster Schritt

Owner, Datum, Erfolgssignal.
MarkdownVorlage anzeigen

ADR Markdown Template

Kompakte Vorlage für Architecture Decision Records im Repository oder Wiki.

# ADR-0001: Titel der Entscheidung

**Status:** proposed
**Datum:** YYYY-MM-DD
**Decider:** Vorname Nachname
**Trigger:** Ticket, Incident oder RFC

## Kontext

Welche Situation macht die Entscheidung nötig? Welche Constraints, Quality Attributes oder früheren Entscheidungen sind relevant?

## Optionen

### Option 1: ...
- Pro:
- Contra:

### Option 2: ...
- Pro:
- Contra:

## Entscheidung

Wir entscheiden uns für ...

## Konsequenzen

Positive Folgen:
- ...

Negative Folgen und Risiken:
- ...

Folge-ADRs oder Tickets:
- ...