跳到主内容
智客 ZICQ

技能库 智客分类:Agent 工作流 architecture-decision-records

Architecture Decision Records

在 Docs/adr/ 中捕获编号为 ADR markdown 文件的建筑决定,并附上上下文、考虑的替代办法、后果和索引 README。 当用户说“ 记录此决定” 或“ ADR this ” 时使用, 在框架或数据库之间选择, 讨论权衡, 或询问为什么代码库是这样塑造的 .

10936 安装量

官方网址:skills.sh

技能介绍

先看中文介绍;官方 description 原文单独保留,不改写 SKILL.md。

做什么

在Docs/adr/中捕获编号为 ADR 标记下的文件的建筑决定,并附上上下文、考虑的替代办法、后果和索引

何时用

用户表示“ 记录此决定” 或“ ADR this ” , 在框架或数据库中选择, 讨论权衡, 或问为什么代码库是这样塑造的

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:Architecture Decision Records、When to Activate、ADR Format、ADR-NNNN: [Decision Title]、Context、Decision。

文件分析

文件分析:这是一份仅含 SKILL.md 的指令型技能,代理激活后整份正文进入上下文。

官方 description(原文)

Capture architectural decisions as numbered ADR markdown files in docs/adr/ with context, alternatives considered, consequences, and an index README. Use when the user says 'record this decision' or 'ADR this', chooses between frameworks or databases, discusses trade-offs, or asks why the codebase is shaped this way.

Architecture Decision RecordsWhen to ActivateADR FormatADR-NNNN: [Decision Title]ContextDecisionAlternatives ConsideredAlternative 1: [Name]Alternative 2: [Name]ConsequencesPositiveNegative

来源分类:skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
name
architecture-decision-records
description
Capture architectural decisions as numbered ADR markdown files in docs/adr/ with context, alternatives considered, consequences, and an index README. Use when the user says 'record this decision' or 'ADR this', chooses between frameworks or databases, discusses trade-offs, or asks why the codebase is shaped this way.
  1. 发现技能客户端向 Agent 提供名称与描述目录。
  2. 匹配与调用用户指定或任务匹配后,载入 SKILL.md 指令。
  3. 按需加载按步骤读取参考文档、使用脚本与素材。

具体调用语法与可用工具以目标 Agent 客户端为准。 查看调用机制说明 ↗

安装这个技能

Skills CLI ↗

先选择目标 Agent 和安装范围,保留技能包的附属文件,安装后检查客户端能否发现该技能。

交给 Agent 安装

复制安装指令给支持 Agent Skills 的代理,确认其中的目标目录与客户端匹配。

把 Agent Skill「architecture-decision-records」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-aca398ba828ffcb8-Architecture-Decision-Records.html
请存为 .cursor/skills/architecture-decision-records/SKILL.md 或 .claude/skills/architecture-decision-records/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。

GitHub 完整包 ↗

终端安装 · Skills CLI

需要 Node.js 与 npx。先查看仓库技能列表,确认实际名称。

npx skills add 'https://github.com/affaan-m/ecc' --list

npx skills add 'https://github.com/affaan-m/ecc' --skill 'architecture-decision-records'

CLI 会交互选择目标 Agent,默认安装到项目;用户级安装使用 -g。先通过查看命令核对仓库内容,再用 npx skills list 检查已安装技能。

阅读排版

name: architecture-decision-records description: Capture architectural decisions as numbered ADR markdown files in docs/adr/ with context, alternatives considered, consequences, and an index README. Use when the user says 'record this decision' or 'ADR this', chooses between frameworks or databases, discusses trade-offs, or asks why the codebase is shaped this way. metadata: origin: ECC

Architecture Decision Records

Capture architectural decisions as they happen during coding sessions. Instead of decisions living only in Slack threads, PR comments, or someone's memory, this skill produces structured ADR documents that live alongside the code.

When to Activate

  • User explicitly says "let's record this decision" or "ADR this"
  • User chooses between significant alternatives (framework, library, pattern, database, API design)
  • User says "we decided to..." or "the reason we're doing X instead of Y is..."
  • User asks "why did we choose X?" (read existing ADRs)
  • During planning phases when architectural trade-offs are discussed

ADR Format

Use the lightweight ADR format proposed by Michael Nygard, adapted for AI-assisted development:

# ADR-NNNN: [Decision Title]

**Date**: YYYY-MM-DD
**Status**: proposed | accepted | deprecated | superseded by ADR-NNNN
**Deciders**: [who was involved]

## Context

What is the issue that we're seeing that is motivating this decision or change?

[2-5 sentences describing the situation, constraints, and forces at play]

## Decision

What is the change that we're proposing and/or doing?

[1-3 sentences stating the decision clearly]

## Alternatives Considered

### Alternative 1: [Name]
- **Pros**: [benefits]
- **Cons**: [drawbacks]
- **Why not**: [specific reason this was rejected]

### Alternative 2: [Name]
- **Pros**: [benefits]
- **Cons**: [drawbacks]
- **Why not**: [specific reason this was rejected]

## Consequences

What becomes easier or more difficult to do because of this change?

### Positive
- [benefit 1]
- [benefit 2]

### Negative
- [trade-off 1]
- [trade-off 2]

### Risks
- [risk and mitigation]

Workflow

Capturing a New ADR

When a decision moment is detected:

  1. Initialize (first time only) — if docs/adr/ does not exist, ask the user for confirmation before creating the directory, a README.md seeded with the index table header (see ADR Index Format below), and a blank template.md for manual use. Do not create files without explicit consent.
  2. Identify the decision — extract the core architectural choice being made
  3. Gather context — what problem prompted this? What constraints exist?
  4. Document alternatives — what other options were considered? Why were they rejected?
  5. State consequences — what are the trade-offs? What becomes easier/harder?
  6. Assign a number — scan existing ADRs in docs/adr/ and increment
  7. Confirm and write — present the draft ADR to the user for review. Only write to docs/adr/NNNN-decision-title.md after explicit approval. If the user declines, discard the draft without writing any files.
  8. Update the index — append to docs/adr/README.md

Reading Existing ADRs

When a user asks "why did we choose X?":

  1. Check if docs/adr/ exists — if not, respond: "No ADRs found in this project. Would you like to start recording architectural decisions?"
  2. If it exists, scan docs/adr/README.md index for relevant entries
  3. Read matching ADR files and present the Context and Decision sections
  4. If no match is found, respond: "No ADR found for that decision. Would you like to record one now?"

ADR Directory Structure

docs/
└── adr/
    ├── README.md              ← index of all ADRs
    ├── 0001-use-nextjs.md
    ├── 0002-postgres-over-mongo.md
    ├── 0003-rest-over-graphql.md
    └── template.md            ← blank template for manual use

ADR Index Format

# Architecture Decision Records

| ADR | Title | Status | Date |
|-----|-------|--------|------|
| [0001](0001-use-nextjs.md) | Use Next.js as frontend framework | accepted | 2026-01-15 |
| [0002](0002-postgres-over-mongo.md) | PostgreSQL over MongoDB for primary datastore | accepted | 2026-01-20 |
| [0003](0003-rest-over-graphql.md) | REST API over GraphQL | accepted | 2026-02-01 |

Decision Detection Signals

Watch for these patterns in conversation that indicate an architectural decision:

Explicit signals

  • "Let's go with X"
  • "We should use X instead of Y"
  • "The trade-off is worth it because..."
  • "Record this as an ADR"

Implicit signals (suggest recording an ADR — do not auto-create without user confirmation)

  • Comparing two frameworks or libraries and reaching a conclusion
  • Making a database schema design choice with stated rationale
  • Choosing between architectural patterns (monolith vs microservices, REST vs GraphQL)
  • Deciding on authentication/authorization strategy
  • Selecting deployment infrastructure after evaluating alternatives

What Makes a Good ADR

Do

  • Be specific — "Use Prisma ORM" not "use an ORM"
  • Record the why — the rationale matters more than the what
  • Include rejected alternatives — future developers need to know what was considered
  • State consequences honestly — every decision has trade-offs
  • Keep it short — an ADR should be readable in 2 minutes
  • Use present tense — "We use X" not "We will use X"

Don't

  • Record trivial decisions — variable naming or formatting choices don't need ADRs
  • Write essays — if the context section exceeds 10 lines, it's too long
  • Omit alternatives — "we just picked it" is not a valid rationale
  • Backfill without marking it — if recording a past decision, note the original date
  • Let ADRs go stale — superseded decisions should reference their replacement

ADR Lifecycle

proposed → accepted → [deprecated | superseded by ADR-NNNN]
  • proposed: decision is under discussion, not yet committed
  • accepted: decision is in effect and being followed
  • deprecated: decision is no longer relevant (e.g., feature removed)
  • superseded: a newer ADR replaces this one (always link the replacement)

Categories of Decisions Worth Recording

| Category | Examples | |----------|---------| | Technology choices | Framework, language, database, cloud provider | | Architecture patterns | Monolith vs microservices, event-driven, CQRS | | API design | REST vs GraphQL, versioning strategy, auth mechanism | | Data modeling | Schema design, normalization decisions, caching strategy | | Infrastructure | Deployment model, CI/CD pipeline, monitoring stack | | Security | Auth strategy, encryption approach, secret management | | Testing | Test framework, coverage targets, E2E vs integration balance | | Process | Branching strategy, review process, release cadence |

Integration with Other Skills

  • Planner agent: when the planner proposes architecture changes, suggest creating an ADR
  • Code reviewer agent: flag PRs that introduce architectural changes without a corresponding ADR

相关技能

Agent 工作流

Skill Creator

创造有效技能指南。 当用户想创造出新的技能(或更新现有的技能),以专业知识,工作流程,或工具集成来扩展克洛德的能力时,应该使用这种技能.

Agent 工作流

Clawdhub

使用ClawdHub CLI搜索,安装,更新并发布从taladhub.com的代理技能. 需要获取苍蝇上的新技能时使用,将安装的技能同步到最新版本或特定版本,或者发布 npm-instainddhub CLI 的新/更新的技能文件夹.

Agent 工作流

Agent Team Orchestration

管弦乐团多代理团队,任务设定周期,交接协议,审查工作流程. 使用时间: (1)建立2+特派员队伍,具有不同专业,(2)确定任务路线和生命周期(收录框_ spec_建设_审查_完成),(3)在特派员之间制定交接协议,(4)建立审查和质量关口,(5)管理特派员之间的交流和文物共享.

Agent 工作流

Superpowers

Spec-first,TDD,子代理驱动的软件开发工作流程. 当:(1)构建任何新功能或应用——触发脑暴_计划_子代理执行回路,(2)调试出一个bug或测试失败——触发系统性的根起过程,(3)用户说"让我们构建","帮助我计划","我想添加X",或"这个被打破",(4)完成一个功…