mattrguerra.comHouston area
Matt Guerra
  1. 01AI & Automation
  2. 02Photography
  3. 03Design
  4. 04About
  5. 05Notes
  6. 06Contact
Back to the systems

mattrguerra/meridian-skillsmainPrivate on GitHub, published here in full

DECISIONS.md.tmpl

1.8 KB72 lines

skills/cowork-project-architect/templates/DECISIONS.md.tmpl

  1. ---
  2. type: decisions
  3. scope: project-root
  4. tags:
  5. - claude
  6. - decisions
  7. - adr
  8. - append-only
  9. created: [YYYY-MM-DD]
  10. updated: [YYYY-MM-DD]
  11. ---
  13. <!--
  14. DECISIONS.md: Architecture Decision Records.
  16. Pairs with [[CHANGELOG]]. CHANGELOG records WHAT changed; DECISIONS records WHY.
  17. Each decision is a self-contained record so future-you can audit reasoning
  18. without context loss.
  20. When to write a new ADR:
  21. - A real architectural choice was made (not just a minor tweak).
  22. - The choice eliminated other options that someone might reasonably propose
  23. again later.
  24. - The reasoning is non-obvious from the code/files alone.
  25. -->
  27. # [PROJECT NAME]: Decisions
  29. Architecture decision records, append-only. Each ADR is a self-contained record of a non-trivial choice and its reasoning.
  31. ---
  33. ## ADR-001: [DECISION TITLE]
  35. **Date:** [YYYY-MM-DD]
  36. **Status:** Accepted
  38. **Context:**
  39. [2-4 sentences. What was the situation that forced a decision? What were the constraints?]
  41. **Options considered:**
  42. 1. [Option A]: [one-line summary]
  43. 2. [Option B]: [one-line summary]
  44. 3. [Option C]: [one-line summary]
  46. **Decision:**
  47. [The chosen option, stated clearly. One paragraph max.]
  49. **Reasoning:**
  50. [Why this option won. What trade-offs were accepted. What was given up.]
  52. **Consequences:**
  53. - [What this enables or requires going forward]
  54. - [What this rules out]
  55. - [What signal would cause us to revisit this]
  57. **Related:**
  58. - Changelog entry: [[CHANGELOG#YYYY-MM-DD]]
  59. - Affected files: [[FILE]], [[FILE]]
  61. ---
  63. <!-- Future ADRs use the same structure. Increment the number, never reuse.
  64. If a decision is later reversed, add a new ADR that supersedes the old one
  65. and update the old one's Status to "Superseded by ADR-NNN". Don't delete it.
  67. Status values:
  68. - Proposed: under consideration
  69. - Accepted: current standing decision
  70. - Superseded: replaced by a later ADR
  71. - Deprecated: abandoned without direct replacement
  72. -->