Workflow Documentation

Write an Architecture Decision Record

Workflow for documenting an architectural decision

documentationarchitecturedecisions
CLAUDE.md

When documenting an architectural decision:

  1. Title: a short noun phrase describing the decision. “Use PostgreSQL for the event store.”
  2. Status: Proposed, Accepted, Deprecated, or Superseded.
  3. Context: what is the situation that motivates this decision? What constraints exist?
  4. Decision: state the decision clearly in one or two sentences.
  5. Alternatives considered: what other options were evaluated and why were they rejected?
  6. Consequences: what are the positive and negative results of this decision? What becomes easier or harder?
  7. Keep it brief — one page maximum. ADRs are for recording decisions, not justifying them at length.

Copy this workflow into your CLAUDE.md or agent config file so your agent follows this process automatically.

get crystl