From f97ba688267c4dfe53620b9cf9dc15a2006f36c9 Mon Sep 17 00:00:00 2001 From: Jordan Robinson Date: Sun, 19 Oct 2025 15:34:03 +0100 Subject: [PATCH] add architecture decision record template --- README.md | 1 + templates/architecture-decision-record.md | 66 +++++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 templates/architecture-decision-record.md diff --git a/README.md b/README.md index 98a9fd8893dc3dc80c0343bcd634ebe4e2454577..0e8c8bb33619f8a8339949be14552010831649f4 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,4 @@ Comprehensive collection of templates for solutions design, architecture decisio * Feature Request * Bug Fix * Performance Optimisation +* Architecture Decision Record (ADR) diff --git a/templates/architecture-decision-record.md b/templates/architecture-decision-record.md new file mode 100644 index 0000000000000000000000000000000000000000..ffe9c5bfb2f39d763cf153d260b346c39f55455e --- /dev/null +++ b/templates/architecture-decision-record.md @@ -0,0 +1,66 @@ +# Architecture Decision Record (ADR) + +## Header +**ADR Number:** [ADR-XXX] +**Title:** [Brief title of architectural decision] +**Status:** [Proposed/Accepted/Deprecated/Superseded by ADR-XXX] +**Date:** [Created date] +**Last Updated:** [Date] +**Author:** [Name] +**Stakeholders:** [List of stakeholders involved] + +## Context +Describe the issue or problem that motivated this decision. What circumstances made this decision necessary? Include relevant background, constraints, and business drivers. + +## Decision +State the architectural decision clearly and concisely. What exactly are we deciding to do? + +## Rationale +Explain why this decision was made: +- Why this approach over alternatives +- How it addresses the context/problem +- Technical and business justifications +- Long-term implications + +## Alternatives Considered +List other options evaluated: + +**Alternative 1: [Name]** +- Pros +- Cons +- Why not chosen + +**Alternative 2: [Name]** +- Pros +- Cons +- Why not chosen + +## Consequences + +### Positive +- Benefits of this decision +- What improves + +### Negative +- Trade-offs and compromises +- Future constraints +- Maintenance burden + +### Neutral +- No significant impact areas + +## Implementation Notes +- How will this be implemented? +- Which teams are responsible? +- Timeline considerations +- Dependencies + +## Related ADRs +- References to related decisions +- Supersedes (if applicable) +- Is superseded by (if applicable) + +## References +- Links to relevant documentation +- External resources +- Design documents \ No newline at end of file