Refine ADR structure and context
This commit is contained in:
+26
-1
@@ -1,3 +1,28 @@
|
||||
# Architecture Decision Records
|
||||
|
||||
ADRs dokumentieren zentrale Architekturentscheidungen. Neue ADRs werden fortlaufend nummeriert und sollen Entscheidung, Kontext und Konsequenzen enthalten.
|
||||
ADRs dokumentieren zentrale Architekturentscheidungen. Sie werden fortlaufend nummeriert.
|
||||
|
||||
## Verbindliche Struktur
|
||||
|
||||
Jedes ADR verwendet diese Gliederung:
|
||||
|
||||
```text
|
||||
# ADR NNNN - Titel
|
||||
## Status
|
||||
## Kontext
|
||||
## Entscheidung
|
||||
## Begründung
|
||||
## Konsequenzen
|
||||
```
|
||||
|
||||
## Abschnitte
|
||||
|
||||
- `Status`: aktueller Zustand der Entscheidung, zum Beispiel Vorgeschlagen, Akzeptiert, Ersetzt oder Verworfen.
|
||||
- `Kontext`: Ausgangslage und Problemstellung.
|
||||
- `Entscheidung`: konkret getroffene Architekturentscheidung.
|
||||
- `Begründung`: Gründe für die gewählte Lösung.
|
||||
- `Konsequenzen`: positive, negative und organisatorische Folgen.
|
||||
|
||||
## Umgang mit bestehenden ADRs
|
||||
|
||||
Bereits akzeptierte ADRs werden nicht stillschweigend inhaltlich umgedeutet. Wird eine Entscheidung ersetzt, soll ein neues ADR angelegt und das alte ADR entsprechend referenziert werden.
|
||||
|
||||
Reference in New Issue
Block a user