跳到正文
cccskills
免费在 GitHub 公开

architecture-decision-records

Capture architectural decisions made during Claude Code sessions as structured ADRs. Auto-detects decision moments, records context, alternatives considered, and rationale. Maintains an ADR log so future developers understand why the codebase is shaped the way it is.

中文简介正在准备中。当前显示原文说明。

集成工具PostgreSQL
查看安装方法

包含的文件(1)

  • SKILL.md7.0 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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

CategoryExamples
Technology choicesFramework, language, database, cloud provider
Architecture patternsMonolith vs microservices, event-driven, CQRS
API designREST vs GraphQL, versioning strategy, auth mechanism
Data modelingSchema design, normalization decisions, caching strategy
InfrastructureDeployment model, CI/CD pipeline, monitoring stack
SecurityAuth strategy, encryption approach, secret management
TestingTest framework, coverage targets, E2E vs integration balance
ProcessBranching 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

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Use AtomLane to compile and execute safe atomic parallel plans on macOS and native Windows Preview for worthwhile independent argv tasks, dependency DAGs, supported platform entrypoints, or Apple-silicon operators. Use at task start or an execution boundary when structured local work may contain two or more worthwhile units; skip plain answers, one quick command, and work whose effects cannot be safely bounded.

中文简介正在准备中。当前显示原文说明。

hashgraph-online/awesome-codex-plugins13552026年10月19日 更新

add

免费

Register a deferred decision in the debt registry. Trigger by judgment, not a marker scan, whenever a future reader would ask "why this way?": an unmade decision, stub, loosened type, bypassed check, swallowed error, a default picked "for now", or a TODO/FIXME/HACK/XXX marker. Trigger immediately whenever you defer work, or when the user invokes $add. Over-register freely; the developer drops with "drop A", "drop A,C", or "drop all".

中文简介正在准备中。当前显示原文说明。

hashgraph-online/awesome-codex-plugins13552026年10月19日 更新

ADK 框架适配层。为 LangChain / EINO / AutoGen / AgentScope / CrewAI 提供框架特定的 代码模板、惯用模式、API 映射和项目结构,供 agent-dev-workshop Phase 5 代码生成使用。 每个框架 reference 文件标注 verified_date 用于版本锁定。

中文简介正在准备中。当前显示原文说明。

hashgraph-online/awesome-codex-plugins13552026年10月19日 更新

中文调试修复技能。用于报错、测试失败、页面异常、功能不符合预期、需要定位根因并做最小修复时。触发语包括"进入调试模式""帮我修问题""报错了""测试失败""页面坏了""找根因"。

中文简介正在准备中。当前显示原文说明。

hashgraph-online/awesome-codex-plugins13552026年10月19日 更新

交互式 AI Agent 开发工作坊:通过 6 阶段深度协作对话,引导用户完成 Agent 需求分析、架构设计、 工具定义、Prompt 与编排设计、代码生成、验证迭代,产出可直接运行的 Agent 项目。 框架无关设计优先,支持 LangChain / EINO / AutoGen / AgentScope / CrewAI 等 ADK 框架。

中文简介正在准备中。当前显示原文说明。

hashgraph-online/awesome-codex-plugins13552026年10月19日 更新

中文漂移审计技能。用于项目或学习过程变乱、上下文漂移、任务分叉、多个方案冲突、命名不一致、Codex 可能顺手改多了时。触发语包括"漂移检查""感觉跑偏了""项目变乱了""检查是否失控""分叉太多""上下文漂移"。

中文简介正在准备中。当前显示原文说明。

hashgraph-online/awesome-codex-plugins13552026年10月19日 更新

查看 hashgraph-online 的全部技能

报告此技能的问题