跳到主内容
智客 ZICQ

技能库 智客分类:文档办公 develop-adr

Develop Adr

建立符合Nygard格式的架构决定记录,记录重要的技术决定、其背景和后果。 在做出影响系统架构,技术选择或开发模式的技术选择时使用.

729 安装量

官方网址:skills.sh

技能介绍

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

做什么

按照Nygard格式创建结构决定记录,记录重要的技术决定、其背景和后果

何时用

- 作出影响系统架构的重大技术决定

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:Architecture Decision Record (ADR)、When to Use、When NOT to Use、Instructions、Output Format、Quality Checklist。 其中含规范建议的小节:输入输出示例。

文件分析

文件分析:除 SKILL.md 外,正文引用了 references/TEMPLATE.md、references/EXAMPLE.md,属于带资源的技能包,这些文件按需再读。

官方 description(原文)

Creates an Architecture Decision Record following the Nygard format to document significant technical decisions, their context, and consequences. Use when making technical choices that affect system architecture, technology selection, or development patterns.

Architecture Decision Record (ADR)When to UseWhen NOT to UseInstructionsOutput FormatQuality ChecklistExamples

· 许可:Apache-2.0

来源分类:skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
name
develop-adr
description
Creates an Architecture Decision Record following the Nygard format to document significant technical decisions, their context, and consequences. Use when making technical choices that affect system architecture, technology selection, or development patterns.
许可
Apache-2.0
  1. 发现技能客户端向 Agent 提供名称与描述目录。
  2. 匹配与调用用户指定或任务匹配后,载入 SKILL.md 指令。
  3. 按需加载按步骤读取参考文档、使用脚本与素材。
指令中引用的文件 · 2
  • references/TEMPLATE.md
  • references/EXAMPLE.md

以下路径提取自原文;文件是否齐全请以来源仓库中的完整目录为准。

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

安装这个技能

Skills CLI ↗

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

该技能引用了附属文件,请从来源获取完整目录;仅复制 SKILL.md 可能缺少依赖。

交给 Agent 安装

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

把 Agent Skill「develop-adr」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-4c8ec4bf16472159-%E5%BC%80%E5%8F%91-Adr.html
请存为 .cursor/skills/develop-adr/SKILL.md 或 .claude/skills/develop-adr/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。
该技能还带 scripts/、references/、assets/ 等文件,请从 https://github.com/product-on-purpose/pm-skills 取完整目录,不要只建一个 SKILL.md。

GitHub 完整包 ↗

终端安装 · Skills CLI

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

npx skills add 'https://github.com/product-on-purpose/pm-skills' --list

npx skills add 'https://github.com/product-on-purpose/pm-skills' --skill 'develop-adr'

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

阅读排版
--- name: develop-adr description: Creates an Architecture Decision Record following the Nygard format to document significant technical decisions, their context, and consequences. Use when making technical choices that affect system architecture, technology selection, or development patterns. license: Apache-2.0 metadata: phase: develop version: "3.0.0" updated: 2026-08-21 category: specification frameworks: [triple-diamond, lean-startup, design-thinking] author: product-on-purpose --- # Architecture Decision Record (ADR) An Architecture Decision Record documents a significant technical decision along with its context and consequences. ADRs capture the "why" behind architectural choices so future team members understand the reasoning - especially important when they question why something was done a particular way. This skill follows Michael Nygard's lightweight ADR format. ## When to Use - Making significant technical decisions that affect system architecture - Choosing between technology options (frameworks, databases, services) - Establishing patterns that future development should follow - Documenting the rationale for constraints or non-obvious approaches - Preserving institutional knowledge about past decisions ## When NOT to Use - The decision is a product or UX design choice, not architecture or technology -> use `develop-design-rationale` - You are still exploring whether an approach is feasible -> time-box the exploration and record it with `develop-spike-summary` first - You need to pitch a solution to stakeholders -> use `develop-solution-brief`; an ADR records a decision, it does not sell one - Nothing is actually being decided (the status quo continues unchanged): an ADR without a decision is noise; wait until there is one ## Instructions When asked to create an ADR, follow these steps: 1. **Assign a Number and Title** ADRs are numbered sequentially (ADR-001, ADR-002, etc.) for easy reference. The title should be a short noun phrase describing the decision, like "Use PostgreSQL for order data" or "Adopt React for frontend." 2. **Set the Status** New ADRs start as "Proposed." After team review, they become "Accepted," "Deprecated," or "Superseded by ADR-XXX." Status changes should be tracked. 3. **Describe the Context** Explain the circumstances that led to this decision. What problem are you solving? What forces are at play (technical constraints, team expertise, timeline, cost)? This section should help a reader who wasn't there understand why this decision was needed. 4. **State the Decision** Clearly articulate what you decided. Use active voice: "We will use..." rather than "It was decided..." Be specific about what is and isn't included in the decision. 5. **Document the Consequences** List the outcomes of this decision - positive, negative, and neutral. Good ADRs are honest about trade-offs. What becomes easier? What becomes harder? What new constraints or options does this create? 6. **Record the Model-Choice Consequences** *(only when the decision selects a model or commits the system to one)* Skip this step entirely otherwise; it is a subsection inside Consequences, not a seventh heading. A model choice differs from an ordinary dependency choice in one way that matters for an ADR: the thing you evaluated will be replaced, often inside the life of this decision. So record what the choice costs to undo, not just which option won. Name whether you are building, buying, or prompting a general model and what ruled the other two out; what is now coupled to the choice (prompts, evaluation sets, output schemas, latency budgets); the operating cost accepted and the volume at which it stops being acceptable; the real reversal cost given that coupling; and the observation that would reopen this ADR, which is a trigger rather than a review date. ## Output Format Use the template in `references/TEMPLATE.md` to structure the output. A complete ADR fills every template section: Status; Context; Decision; Consequences; Alternatives Considered; and References. ## Quality Checklist Before finalizing, verify: - [ ] Title is a short, descriptive noun phrase - [ ] Status is clearly indicated (Proposed/Accepted/Deprecated/Superseded) - [ ] Context explains why this decision was needed - [ ] Decision is stated clearly in active voice - [ ] Consequences include both positive and negative outcomes - [ ] ADR can stand alone without requiring other documents - [ ] If the decision selects or commits to a model: coupling, operating cost, reversal cost, and the observation that would reopen the decision are all recorded ## Examples See `references/EXAMPLE.md` for a completed example.

相关技能

文档办公

Ontology

为结构化的代理内存和可堆肥技能所打入的知识图. 在创建/征服实体(Person, project, Task, Evention, Document)时使用,链接相关对象,强制约束,规划多步动作作为图变,或技能需要共享状态时使用. 触发到"记住","我知道什么","链接X到Y",…

文档办公

Nano Pdf

使用纳米-pdf CLI编辑带有自然语言指令的PDF.

文档办公

Word / DOCX

创建,检查,并编辑有可靠样式的Microsoft Word文档和DOCX文件,编号,跟踪更改,表格,章节,并进行相容性检查. 当 (1) 任务涉及 Word 或 ".docx " 时使用; (2) 文件包括跟踪的更改,评论,字段,表格,模板,或页面布局限制; (3) 文档必须在不…

文档办公

Api Gateway

通过 Maton 网关调用第三方 API, 它为用户已经连接的应用程序注入证书 。 当用户命名一个连接的应用程序和其中的具体行动时使用此技能——读取一个邮箱,查询一个CMM,归档一个问题,更新一个电子表格,通过一个连接的搜索或刮取提供者运行一个查询. 每一次通话都到用户连接的应用…