Skip to content

Clarify ADR immutability and architecture.md as living document - #161

Merged
ralphbean merged 1 commit into
mainfrom
agent-clarify-adr-immutability
Apr 5, 2026
Merged

Clarify ADR immutability and architecture.md as living document#161
ralphbean merged 1 commit into
mainfrom
agent-clarify-adr-immutability

Conversation

@ralphbean

@ralphbean ralphbean commented Apr 3, 2026

Copy link
Copy Markdown
Member

Summary

  • Clarifies that ADRs are point-in-time records whose content is frozen after acceptance. Only status changes and links to superseding ADRs are appropriate modifications.
  • Clarifies that docs/architecture.md is a living document that must always reflect the current state of architectural decisions.

Changes

  • skills/writing-adrs/SKILL.md: Added dedicated sections explaining ADR immutability (what modifications are/aren't acceptable) and architecture.md's role as the always-current document. Added entries to Red Flags and Common Mistakes tables.
  • docs/architecture.md: Added blockquote at the top clarifying its role as a living document.
  • docs/ADRs/0000-adr-template.md: Added HTML comment reminding authors that content is frozen after acceptance.
  • docs/problems/architectural-invariants.md: Updated supersession language to explicitly mention ADR immutability and architecture.md updates. Fixed open question that incorrectly used "ADR amendments" instead of "new superseding ADRs"."

ADRs are point-in-time records. Once accepted, their content should not
be modified -- only status changes and links to superseding ADRs are
appropriate. When decisions change, write a new superseding ADR.

In contrast, docs/architecture.md must always reflect the current state
of decisions. It is updated whenever an ADR is accepted or superseded.

Changes:
- skills/writing-adrs/SKILL.md: Add dedicated sections on ADR
  immutability rules and architecture.md mutability, plus new entries
  in Red Flags and Common Mistakes tables
- docs/architecture.md: Add blockquote clarifying its role as a living
  document
- docs/ADRs/0000-adr-template.md: Add HTML comment reminding authors
  that content is frozen after acceptance
- docs/problems/architectural-invariants.md: Clarify supersession
  language and fix open question about ADR amendments vs supersession

Assisted-by: OpenCode claude-opus-4-6@default
@ralphbean
ralphbean marked this pull request as ready for review April 3, 2026 14:57
@ralphbean

Copy link
Copy Markdown
Member Author

Updates #83

@ralphbean
ralphbean added this pull request to the merge queue Apr 5, 2026
Merged via the queue into main with commit 3239ae4 Apr 5, 2026
1 check passed
@ifireball
ifireball deleted the agent-clarify-adr-immutability branch April 16, 2026 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants