Awesome-claude-code record-adr

Use this to create or modify architecture decision records (ADRs)

install
source · Clone the upstream repo
git clone https://github.com/wmeints/awesome-claude-code
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/wmeints/awesome-claude-code "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/record-adr" ~/.claude/skills/wmeints-awesome-claude-code-record-adr && rm -rf "$T"
manifest: skills/record-adr/SKILL.md
source content

IMPORTANT: Use the template stored in

./templates/adr.md
to record the architecture decision.

Guidelines for recording the decision

  • Use a single sentence to describe the decision made.
  • Defer any explanation for why to the context section.

Guidelines for recording the context

  • Make sure to include alternatives to the choice we're recording.
  • Explain why we have to make the choice in the first place.

IMPORTANT: If you don't have this information, ask the user to provide the information!

Guidelines for recording the options considered

  • Create a sub section per option and provide a short description of the pros and cons of the option.
  • Keep the description short and concise

Guidelines for recording the consequences

  • List the consequences one-by-one
  • Include both positive and negative consequences in the list

Where to store the ADR files

  • Store ADR files in
    docs/architecture/adr
  • Give a unique number to each ADR and write files like this:
    001-title-of-the-adr.md
  • Include the ADR in the TOC in
    09-decisions.md
    located in
    docs/architecture