Add foundational documentation templates to support product design and architecture planning, including ADR, archetypes, LLM systems, dev setup, and shared modules.
This commit is contained in:
32
docs/adr/0000-template.md
Normal file
32
docs/adr/0000-template.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# ADR-0000: <Decision Title>
|
||||
|
||||
---
|
||||
**Status:** proposed | accepted | superseded | rejected
|
||||
**Date:** YYYY-MM-DD
|
||||
**Owners:** <names/roles>
|
||||
**Related:** <links to other ADRs / docs>
|
||||
---
|
||||
|
||||
## Context
|
||||
What problem are we solving?
|
||||
What constraints matter (scale, compliance, team, timeline, cost)?
|
||||
|
||||
## Decision
|
||||
State the decision clearly and specifically.
|
||||
|
||||
## Alternatives Considered
|
||||
List viable alternatives with short pros/cons.
|
||||
|
||||
## Consequences
|
||||
### Positive
|
||||
- …
|
||||
|
||||
### Negative / Risks
|
||||
- …
|
||||
|
||||
## Migration / Rollback Plan
|
||||
If we change our mind later, how do we move safely?
|
||||
|
||||
## References
|
||||
- Links to relevant docs, benchmarks, vendor docs, or prototypes.
|
||||
|
||||
Reference in New Issue
Block a user