Skip to content
FunCoding

Search

Search docs, Skills and MCP

recording-architecture-decisions

Use when the user asks to create, write, update, amend, supersede, or evaluate an ADR, architecture decision record, durable architecture decision, decision log, or baseline sync after architecture-changing work.

代码质量与审查1.3kskills/recording-architecture-decisions/SKILL.md

Install

Send this to Claude Code, Codex or Cursor. The agent checks the Skill for safety first and installs it only after you confirm.

读取 https://funcoding.ai/skills/ganyuanran/aegis/recording-architecture-decisions/install.md ,按里面的步骤帮我安装这个 Skill。

SKILL.md

Recording Architecture Decisions

Purpose

Record durable architecture decisions without losing the current-state baseline closure. An ADR records why a decision was made; a baseline records what the architecture is after that decision.

This skill is a lazy, task-specific workflow. It does not replace verification-before-completion, does not grant completion authority, and does not make authoritative GateDecision or PolicySnapshot outputs.

Required Read Set

Before deciding or writing, read the smallest relevant excerpts from:

  • docs/adr/ADR-CREATION-GATE.md
  • docs/current/AEGIS_ADR_AUTO_BACKFILL.md
  • the target project's current ADR, baseline, or authority docs that own the affected architecture surface

For Aegis repository changes, use this repository's docs/adr/ and docs/current/ authority order. For target projects with their own ADR system, respect that project owner instead of duplicating the same decision into docs/aegis/adr/.

When To Use

Use this skill when the user asks to:

  • create, write, update, amend, supersede, or evaluate an ADR
  • decide whether an architecture decision record is needed
  • record a durable architecture decision or decision log entry
  • close baseline sync after an ADR-relevant architecture change
  • verify that an ADR action did not leave the architecture baseline stale

Do not use it for simple wording edits, ordinary README cleanup, tests-only coverage improvements, low-risk single-file changes, or bug fixes that only restore the existing baseline.

Decision Flow

  1. Identify the decision candidate and evidence source.
  2. Run the ADR creation gate:
    • hard to reverse
    • surprising without context
    • real trade-off
  3. Apply the Retro / Memory Filter:
    • executed durable decisions may become ADR or baseline memory
    • unexecuted ideas stay out of accepted architecture memory
    • process notes may use a lighter record when they do not change current architecture state
  4. Choose exactly one ADR action: create, amend, supersede, or skip.
  5. Choose the owner surface: project docs/adr/, docs/aegis/adr/, existing ADR, or lighter record.
  6. Run Baseline Sync Closure.
  7. If writing files, preserve local ADR conventions and verify structure.

Helper-Backed Write Path

When the chosen owner surface is a target project's docs/aegis/adr/, use the shared workspace helper instead of ad-hoc file creation:

  • create -> <aegis-workspace-helper> new-adr --root <target-project-root> ...
  • amend -> <aegis-workspace-helper> amend-adr --root <target-project-root> --path docs/aegis/adr/ADR-####-<slug>.md ...
  • supersede -> <aegis-workspace-helper> supersede-adr --root <target-project-root> --path docs/aegis/adr/ADR-####-<slug>.md ...

After helper-backed writeback, run:

  • <aegis-workspace-helper> check --root <target-project-root>

The helper owns file shape, ADR numbering, supersession markers, and INDEX.md coverage only. It does not decide architecture truth, whether the ADR gate passed, or whether baseline sync is semantically sufficient.

If the ADR gate or owner-surface decision says skip, do not create or amend ADR files just because the helper exists. An ADR signal in a design/plan is a note for later completion, not an ADR file. Create/amend/supersede an ADR only for an executed durable decision; if an existing ADR already covers the decision surface, amend it instead of creating a sibling.

Baseline Sync Closure

If the ADR action is create, amend, or supersede, baseline sync must be checked.

Baseline sync is required when the decision changes or confirms any of:

  • canonical owner or ownership map
  • public API, schema, artifact shape, or behavior contract
  • dependency direction or allowed cross-module relationship
  • source-of-truth owner
  • host compatibility strategy or install/discovery contract
  • method-pack/runtime-core boundary
  • runtime-ready artifact boundary or evidence model
  • retained fallback, adapter, compatibility path, duplicate owner, or retirement schedule
  • accepted architecture-scoped Implementation Drift
  • release or distribution strategy that future contributors would otherwise misread

If no baseline writeback is made, state why the existing baseline remains valid. Never leave baseline sync implicit after create, amend, or supersede.

Compact Output Contract

Aegis Visibility:
- Why executed-decision filtering, ADR gate, owner surface, or baseline sync matters now:

Decision Candidate:
- Summary:
- Evidence source:

ADR Gate:
- Hard to reverse: yes | no | unknown
- Surprising without context: yes | no | unknown
- Real trade-off: yes | no | unknown

Retro / Memory Filter:
- Classification: executed durable decision | unexecuted idea | process note
- Memory action: record | skip | lighter record
- Reason:

ADR Action:
- create | amend | supersede | skip
- Reason:

Owner Surface:
- Target:
- Existing ADR / baseline checked:

Baseline Sync:
- Required: yes | no | unknown
- Target:
- Action: create snapshot | update baseline | cite unchanged | blocked
- Reason:

Boundary:
- Advisory method-pack signal only; not completion authority.

Common Mistakes

  • Writing an ADR because the topic feels important, even though the gate fails.
  • Recording why in an ADR while leaving the baseline's current-state facts stale.
  • Updating a baseline to match drift without first deciding whether the drift is intentional and ADR-worthy.
  • Duplicating the same decision into both project docs/adr/ and docs/aegis/adr/ without an explicit mirror relationship.
  • Treating an ADR or baseline sync as proof that the work is complete.

Similar Skills

claude-api
anthropics/skills180k

claude-api

Reference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).

Code quality & review

ponytail-review
DietrichGebert/ponytail158k

ponytail-review

Quality review of a change: is the logic right, is it safe, does it hold under real load, is risky code tested, is it fast enough, and is every line needed. Reads the connected code, not only the diff. Each finding is explained in plain English. Use for "review this", "code review", "review the last commit", "review my PR", "is this over-engineered", /ponytail-review.

Code quality & review

code-review-and-quality
addyosmani/agent-skills103k

code-review-and-quality

Conducts multi-axis code review. Use before merging any change. Use when reviewing code written by yourself, another agent, or a human. Use when you need to assess code quality across multiple dimensions before it enters the main branch. Use when asked to review a diff or a pull request, even when the diff is pasted inline.

Code quality & review

documentation-and-adrs
addyosmani/agent-skills103k

documentation-and-adrs

Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.

Code quality & review

code-simplification
addyosmani/agent-skills103k

code-simplification

Simplifies code for clarity. Use when refactoring code for clarity without changing behavior. Use when code works but is harder to read, maintain, or extend than it should be. Use when reviewing code that has accumulated unnecessary complexity.

Code quality & review

understand
Egonex-AI/Understand-Anything86k

understand

Analyze a codebase to produce an interactive knowledge graph for understanding architecture, components, and relationships

Code quality & review