Upload platform/adr/template.md with huggingface_hub
Browse files- platform/adr/template.md +42 -0
platform/adr/template.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ADR-XXXX: [Decision Title]
|
| 2 |
+
|
| 3 |
+
## Status
|
| 4 |
+
Proposed | Accepted | Deprecated | Superseded by ADR-YYYY
|
| 5 |
+
|
| 6 |
+
## Context
|
| 7 |
+
[What is the issue that we are seeing that is motivating this decision?]
|
| 8 |
+
|
| 9 |
+
## Decision
|
| 10 |
+
[What is the change that we are proposing/making?]
|
| 11 |
+
|
| 12 |
+
## Consequences
|
| 13 |
+
|
| 14 |
+
### Positive
|
| 15 |
+
- [Benefit 1]
|
| 16 |
+
- [Benefit 2]
|
| 17 |
+
|
| 18 |
+
### Negative
|
| 19 |
+
- [Tradeoff 1]
|
| 20 |
+
- [Tradeoff 2]
|
| 21 |
+
|
| 22 |
+
### Risks
|
| 23 |
+
- [Risk 1 and mitigation]
|
| 24 |
+
|
| 25 |
+
## Alternatives Considered
|
| 26 |
+
| Option | Pros | Cons | Verdict |
|
| 27 |
+
|--------|------|------|---------|
|
| 28 |
+
| Option A | ... | ... | Rejected because... |
|
| 29 |
+
| Option B | ... | ... | Rejected because... |
|
| 30 |
+
| **Chosen** | ... | ... | Accepted |
|
| 31 |
+
|
| 32 |
+
## Compliance Impact
|
| 33 |
+
- [Does this affect SOC2/NIST/CIS controls?]
|
| 34 |
+
|
| 35 |
+
## Cost Impact
|
| 36 |
+
- [Does this change cloud spend? Estimate.]
|
| 37 |
+
|
| 38 |
+
## Security Impact
|
| 39 |
+
- [Does this affect attack surface? IAM? Encryption?]
|
| 40 |
+
|
| 41 |
+
## References
|
| 42 |
+
- [Link to relevant docs, papers, discussions]
|