Fleshed out documentation
This commit is contained in:
Vendored
+25
@@ -0,0 +1,25 @@
|
||||
# ADR <NNNN>: <Title>
|
||||
|
||||
## Status
|
||||
|
||||
Proposed | Accepted | Deprecated | Superseded
|
||||
|
||||
## Context
|
||||
|
||||
Explain the problem and the forces at play. Include constraints, risks, or user needs.
|
||||
|
||||
## Decision
|
||||
|
||||
State the decision clearly and explicitly.
|
||||
|
||||
## Consequences
|
||||
|
||||
List the expected positive and negative outcomes, including operational impact.
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
Briefly document viable alternatives and why they were rejected.
|
||||
|
||||
## Related
|
||||
|
||||
Link to relevant PRs, runbooks, or architecture sections.
|
||||
Reference in New Issue
Block a user