文档

Architecture Decision Record

试用

Create an Architecture Decision Record (ADR) for any technical decision. Use when asked to document a technical decision, write an ADR, record an architectur...

它能做什么

Architecture Decision Record (ADR) Skill

技能文档

Architecture Decision Record (ADR) Skill

This skill produces a complete Architecture Decision Record (ADR) following the Nygard format — the most widely adopted standard. ADRs document the reasoning behind significant technical decisions so future team members understand not just what was decided, but why.

Required Inputs

Ask the user for these if not provided:

  • ADR number (sequential number in your ADR registry — e.g. 012; or "next available" if unknown)
  • Decision title (brief, e.g. "Use PostgreSQL as primary datastore")
  • Context (what situation led to this decision needing to be made?)
  • Options considered (at least 2; if only 1 is given, prompt for alternatives that were considered or ruled out)
  • Decision made (which option was chosen)
  • Reason for choice
  • Status (Proposed / Accepted / Deprecated / Superseded)
  • Author and date
  • Team context (optional — team size, relevant experience, org constraints; helps calibrate formality and depth of the Context section)

Output Format


ADR-[NNN]: [Decision Title]

Date: [YYYY-MM-DD] Status: [Proposed / Accepted / Deprecated / Superseded by ADR-NNN] Author(s): [Name(s)] Deciders: [Who had final say — individual or team]


Context

[3–6 sentences. Describe the situation, constraints, and forces at play that made this decision necessary. Include: the problem being solved, relevant system state, team constraints, timeline pressures, or non-negotiable requirements. Write as if explaining to someone joining the team 18 months from now who has no prior context.]

Key constraints:

  • [Constraint 1: e.g. "Must be deployable on-premise for enterprise customers"]
  • [Constraint 2: e.g. "Team has no prior Go experience"]
  • [Add as many as are relevant]

Options Considered

For each option, produce:

Option [N]: [Name]

Description: [What this option is — 1–3 sentences]

Pros:

  • [Pro 1]
  • [Pro 2]

Cons:

  • [Con 1]
  • [Con 2]

Why this was ruled out (if not chosen): [Honest reason]


Decision

We will [chosen option].

[2–4 sentences explaining the decision in plain language. This should be readable in isolation — someone should understand the decision from this paragraph alone without reading the full document.]


Consequences

Positive Consequences

  • [What this decision enables or improves]
  • [What risk it mitigates]

Negative Consequences / Accepted Tradeoffs

  • [What we're giving up or taking on as a result of this decision]
  • [Technical debt or limitations introduced]
  • [What must now be true for this decision to remain valid]

Risks

  • [What could cause this decision to be wrong in hindsight]
  • [What would trigger us to revisit this decision]

Implementation Notes

[Include if the decision has non-obvious implementation gotchas, or if there are related tickets/RFCs implementers will need. Skip only if the decision is purely tooling selection with no implementation ambiguity.]


Review Date

[Include unless the decision is permanent or self-evidently final. State a specific trigger condition — e.g. "Review if team grows beyond 20 engineers or traffic exceeds 10M requests/day" — not just "should be reviewed periodically".]


Scoring Rubric (0–40)

Score any output of this skill before handing it over; 32+ is ship-quality.

Dimension0510
Context reconstructionAssumes the reader already knows the problem and the pressuresProblem stated, but the forces (team constraints, scale, deadline, forcing event) are missingA reader two years later could guess the decision from the Context section alone
Options honestyOnly the chosen option, or rejected options written as strawmen≥2 options, but rejection reasons are circular ("didn't meet requirements")Every rejected option has genuine strengths and a specific losing constraint tied to a context pressure
Consequence balanceAll consequences are positiveToken negatives with no operational specificsNegatives name real debts, new operational burdens, and what must stay true for the decision to hold
Revisit triggersNo risks or review conditions stated"Review periodically" — no measurable conditionSpecific, measurable trigger conditions that would invalidate the decision, with an owner

Quality Checks

  • Context explains the why — not just the what
  • At least 2 options are documented (including the rejected ones)
  • Rejected options include honest reasons for rejection
  • Consequences include negative consequences — no decision is consequence-free
  • Decision is stated in plain language in the Decision section
  • Risks section identifies what would invalidate this decision
  • Context section states the problem explicitly in its first 1–2 sentences (does not assume the reader knows what problem the team was solving)
  • Each rejected option's "Why ruled out" explanation names a specific constraint or trade-off (not a circular statement like "didn't meet our requirements")

Anti-Patterns

  • Do not write an ADR after the decision has already been fully implemented and the team has moved on — ADRs written retrospectively often omit the real reasons and alternatives
  • Do not list only the chosen option — rejected options with honest reasons are the most valuable part of an ADR for future readers
  • Do not write consequences that are all positive — every architectural decision involves trade-offs; an ADR with no negative consequences was not scrutinised honestly
  • Do not leave the status as "Proposed" indefinitely — an ADR that no one has approved is not guiding anyone's decisions
  • Do not write context that assumes the reader already knows what problem was being solved — the context section exists precisely for readers who lack that background

Usage Examples

  • "Write an ADR for using [technology]"
  • "Document our decision to [architectural choice]"
  • "Create an architecture decision record for [topic]"
  • "Help me write up why we chose [option] over [alternative]"

相关技能

把自然语言描述转为结构化 JSON,并由 mcp-diagram-generator MCP 服务生成 Draw.io、Mermaid 或 Excalidraw 图表文件。

作者 nssa.io1.0k 次安装47 星标

从 AdMapix API 拉取广告创意、应用、榜单和收入预估等数据,原样返回结构化 JSON。

作者 fly0pants4.3k 次安装296 星标

在本地磁盘以分类纯 Markdown 文件保存需要长期留存的事实,与智能体内置记忆并存。

作者 Iván559 次安装18 星标

诊断生产力系统反复失效的根因,给出最小干预——容量测算、瓶颈定位、可靠的本地记录。

作者 Iván855 次安装69 星标

以 AI 机器人身份加入视频会议,提供语音、虚拟形象与屏幕共享四种模式。

作者 johnpatternai22 次安装8 星标

执行 Git 操作(提交、分支、合并、变基、冲突解决与恢复)时强制套用安全规则。

作者 Iván535 次安装31 星标

mohitagw15856 的更多技能

浏览全部技能

Extract a brand's visual and verbal identity into an applicable guideline kit — tokens, voice rules, and do/don't pairs — then apply it consistently to any a...

作者 mohitagw158562 次安装

Write an AI usage policy people can actually follow — approved tools, data rules, disclosure duties, and review obligations, in one page instead of legal fog...

作者 mohitagw15856

Write an executive summary for any document, report, or proposal. Use when asked to write an executive summary, management summary, briefing paper, or one-pa...

作者 mohitagw158562 次安装

Convert a git log, commit list, or release notes into a polished, user-facing changelog. Use when writing release notes, generating a CHANGELOG.md entry, or...

作者 mohitagw158562 次安装

Document or design a database schema with entity relationships, table definitions, constraints, indexes, and access patterns. Use when asked to design a data...

作者 mohitagw158561 次安装

Design a 360-degree feedback survey or write a structured 360 feedback report. Use when asked to build a 360 feedback process, write 360 feedback for a colle...

作者 mohitagw158561 次安装