开发与工程

架构决策与工程文档助手

帮助工程团队记录决策依据、维护文档并保留长期代码上下文。

53/ 100
谨慎使用

价值存在,但可靠性、证据或控制措施仍有明显缺口。

查看评分依据 ↓
可直接使用于
Codex · Claude Code
Star 数
★ 107k
最近更新
13 天前
License
MIT
architecture-decision-recordsapi-documentationinline-documentationreadme-maintenance
+1changelog-maintenance

这个 Skill 能做什么,适合哪些场景?

这是 addyosmani/agent-skills 仓库中的 documentation-and-adrs 技能,专注于架构决策记录、API 文档、内联注释、README、变更日志和面向 AI agent 的项目文档。它强调记录“为什么”而不只是“做了什么”,并要求先遵循仓库已有的 ADR 约定。技能还提供 ADR 生命周期、文档检查清单和常见反模式。它适合需要持续维护工程上下文的代码库,但不是自动文档生成器或独立的文档发布工具。

指导 agent 在重大架构决策、公共 API 变更、用户可见功能发布和重复解释问题出现时创建或更新文档;检查现有 ADR、项目指令及相关配置以匹配目录、格式、编号和标题;生成包含状态、日期、背景、决策、替代方案和后果的 ADR;为公共 API 添加参数、返回值、异常和示例说明;为非显而易见的约束记录内联注释和已知陷阱;检查 README、变更日志、规则文件及文档验证项目。

适合
  • 负责架构选型的工程师需要记录框架、数据库、认证策略或基础设施决策及被否决的替代方案。
  • 维护公共 REST、GraphQL 或库接口的团队需要补充类型、参数、返回值、异常和示例文档。
  • 发布改变用户行为的功能时,团队需要同步 README、变更日志和相关项目上下文。
  • 新成员或 AI agent 反复询问同一设计背景时,维护者需要将隐含知识转化为持久文档。

如何安装这个 Skill?

使用前请注意
  • 该评估未执行任何脚本或安装流程,不能确认代理实际触发、生成文档或处理失败的行为。
  • 使用前应补充项目级 ADR 目录、编号规则、敏感信息审查、用户确认和回滚要求;默认模板不应覆盖既有项目约定。
  • 发布者身份未通过 FollowSkills 企业注册表核验,应将维护状态和来源提交记录单独核查。
开始前你需要
Agent 需要具备
  • 本地文件系统

安装整个仓库的 24 个技能:npx skills add addyosmani/agent-skills。也可以先浏览:npx skills add addyosmani/agent-skills --list。README 还展示了按名称安装单个技能的方式,可使用:npx skills add addyosmani/agent-skills --skill documentation-and-adrs。仓库采用 MIT 许可证。

通用方式:手动安装到 Claude Code(macOS / Linux)
tmp="$(mktemp -d)"
git clone --depth 1 https://github.com/addyosmani/agent-skills.git "$tmp"
mkdir -p ~/.claude/skills
cp -R "$tmp/skills/documentation-and-adrs" ~/.claude/skills/
rm -rf "$tmp"

根据源仓库地址和 Skill 路径自动生成,只复制这个 Skill 的文件夹。如果上文有作者提供的安装方式,请优先按作者说明操作;想只在当前项目中使用,把 ~/.claude/skills 换成项目里的 .claude/skills。

如何使用这个 Skill?

试试这样说

安装后,把下面任意一句发给 Agent 即可触发:

  • 为这次数据库选型创建 ADR,先检查仓库现有 ADR 的目录、编号和格式,再记录背景、替代方案、决策与后果。

在支持 Agent Skills 的客户端中,将技能目录作为技能来源使用,并提出具体任务,例如:“为这次数据库选型创建 ADR,先检查仓库现有 ADR 的目录、编号和格式,再记录背景、替代方案、决策与后果。”技能描述表明它会在架构决策、公共 API 变更或功能发布等场景使用。README 未提供该技能专属的独立 slash command,也未说明额外脚本或自动化运行方式。

这个 Skill 有哪些优点和局限?

优点
  • 覆盖 ADR、API 文档、内联注释、README、变更日志和 agent 上下文等常见工程文档场景。
  • 要求优先匹配现有仓库约定,避免引入第二套 ADR 编号或格式。
  • 明确区分记录意图与重复代码,并提供文档后的验证清单。
  • MIT 许可证允许在项目、团队和工具中使用。
局限
  • 内容主要是流程指导和模板,未显示自动创建、校验或发布文档的脚本。
  • 示例和默认 ADR 模板包含 PostgreSQL、Prisma 等具体技术,但这些不是本技能对项目的强制要求。
  • 提供的材料没有展示测试套件、运行时集成或真实项目采用效果。
  • 使用前仍需由团队判断哪些决策足够重大,以及现有文档约定是否存在冲突。

这个 Skill 与同类方案有什么区别?

与相关 Skills 并排比较;分数均按同一 FSRS 标准得出。

Skill FS 评分 Star 数 最近更新 License
架构决策与工程文档助手 本页 53 · 谨慎使用 ★ 107k 13 天前 MIT
Azure 技能创建指南 ✓ Microsoft · 官方 48 · 谨慎使用 ★ 2.7k 3 个月前 MIT
Skill Seekers 自托管引导技能 41 · 不推荐 ★ 15k 26 天前 MIT
Effect JSDoc 规范撰写技能 77 · 高度推荐 ★ 28k 12 天前 MIT
cmux 架构规范技能 63 · 推荐 ★ 28k 12 天前 NOASSERTION

README 将 Superpowers 和 Matt Pocock's skills 列为可比较的替代方案,并链接到比较文档;所提供材料未包含该比较文档的具体结论,因此无法据此断言三者的功能差异。

FollowSkills 如何评估这个 Skill?

FollowSkills 评估 · FSRS-2.0
谨慎使用
53/ 100 五分制 2.7 / 5
上游仓库在本次评估后已有新提交;当前评分仍对应所示审查版本,可能尚未覆盖最新改动。
1信任安全16 / 25 · 3.2/5

该技能仅提供文档与 ADR 指导,不执行命令、不要求凭据或外部服务,权限风险较低;但未明确敏感信息处理、用户确认、数据流、回滚或来源核验,因此未满分。

2可靠稳定8 / 20 · 2.0/5

内容结构一致,包含触发条件、模板、反模式和验证清单,正常使用路径合理;但没有针对该技能关键路径的测试、异常输入处理或可诊断失败反馈,按静态评估限制扣分。

3适用触发10 / 15 · 3.3/5

明确面向架构决策、公共 API、功能发布和团队/代理上下文,并定义了不适用场景;但输出格式、非适用边界和语义触发细则仍较粗,未提供中文支持说明。核心功能不依赖海外服务。

4规范维护9 / 15 · 3.0/5

具备概览、使用时机、模板、生命周期、示例、常见合理化和验证章节,仓库提供 MIT 许可及维护者信息;但该技能自身没有版本、变更记录、安装/依赖说明或明确更新责任与路径。

5有效结果6 / 15 · 2.0/5

提供 ADR 模板、文档原则、API 示例和检查清单,能够直接辅助完成常见文档任务;但内容较通用,缺少该技能实际产出或与替代方案相比的验证证据,仍可能需要较多项目化调整。

6证据核验4 / 10 · 2.0/5

仓库 CI 声称验证技能结构并运行评估,但给出的测试夹具与本技能无关,未见覆盖 ADR、API 文档或验证清单关键路径的专门测试;因此仅给予有限可审计证据分。

1 2 3 4 5 6

点击维度查看打分理由

评估于 2026年7月20日 审查版本 2fbfa004a019 评估证据[1][2][3][4][5]

证据充分度:低 — 主要依赖静态检查、作者材料或有限演示;适合发现线索,不适合做高风险决策。

查看完整评分方法 →

常见问题

这个技能是否收费?
来源没有列出价格;仓库采用 MIT 许可证,并说明可在项目、团队和工具中使用。
它会自动修改代码或运行命令吗?
提供的 SKILL.md 主要给出文档流程、模板和验证项目,没有显示用于修改代码或运行命令的脚本。
它是否只适用于 ADR?
不是。它还覆盖公共 API 文档、内联注释、已知陷阱、README、变更日志以及面向 AI agent 的规则和规格文件。
如果仓库没有 ADR 约定怎么办?
技能建议只有在无法建立现有约定时,才使用 `docs/decisions/`、顺序编号和默认模板。

同仓库的其他 Skills

均来自 addyosmani/agent-skills

开发与工程

官方文档驱动开发

让框架与库的实现决策基于当前官方文档,而不是过时记忆。

★ 107k FS 51 谨慎使用 13 天前
开发与工程

Git 协作与版本发布规范

用可审查、可回滚的 Git 流程管理代码变更与版本发布。

★ 107k FS 54 谨慎使用 13 天前
设计与前端

生产级前端界面工程

帮助 AI 编码代理构建可访问、响应式且符合设计系统的生产级用户界面。

★ 107k FS 53 谨慎使用 13 天前
开发与工程

怀疑驱动开发

在非平凡决策落地前,用新上下文主动寻找错误。

★ 107k FS 52 谨慎使用 13 天前
开发与工程

稳定接口设计指南

帮助工程团队设计稳定、清晰且难以误用的 API 与模块接口。

★ 107k FS 50 谨慎使用 13 天前
开发与工程

合并前代码质量审查

在合并前从正确性、可读性、架构、安全性和性能五个维度审查代码变更。

★ 107k FS 49 谨慎使用 13 天前
开发与工程

浏览器 DevTools 测试

用真实浏览器运行数据验证、调试并测试网页应用。

★ 107k FS 59 推荐 13 天前
开发与工程

需求访谈助手

在规划或编码前,通过逐题访谈确认用户真正想解决的问题。

★ 107k FS 59 推荐 13 天前
开发与工程

测试驱动开发工作流

用可执行的测试先证明需求,再以最小改动实现、重构并验证行为。

★ 107k FS 57 谨慎使用 13 天前
开发与工程

代码简化审查

在不改变行为的前提下,降低代码复杂度并提升可读性与可维护性。

★ 107k FS 57 谨慎使用 13 天前
开发与工程

规范驱动开发

在编码前把模糊需求转化为可验证的开发规范。

★ 107k FS 55 谨慎使用 13 天前
开发与工程

性能优化工程技能

通过测量、定位和验证,系统解决前端、后端、查询与数据库性能瓶颈。

★ 107k FS 54 谨慎使用 13 天前
开发与工程

规划与任务拆解

将明确需求拆分为有依赖顺序、可实现且可验证的工程任务。

★ 107k FS 54 谨慎使用 13 天前
自动化与运维

生产可观测性工程

为生产代码建立日志、指标、追踪与告警,让系统行为可见且便于诊断。

★ 107k FS 53 谨慎使用 13 天前
开发与工程

增量实现

用可验证的小步迭代安全交付多文件工程变更。

★ 107k FS 52 谨慎使用 13 天前
自动化与运维

安全加固工程技能

帮助编码代理在处理不可信输入、身份验证、敏感数据和外部服务时建立系统化安全防线。

★ 107k FS 52 谨慎使用 13 天前
开发与工程

Idea Refine 创意打磨

把模糊想法转化为经过验证、可执行的产品方向。

★ 107k FS 51 谨慎使用 13 天前
开发与工程

上下文工程指南

帮助编码代理在正确时间获取正确项目上下文,减少臆测并保持开发规范一致。

★ 107k FS 49 谨慎使用 13 天前
开发与工程

系统化调试与错误恢复

用结构化流程定位根因,修复错误并防止复发。

★ 107k FS 49 谨慎使用 13 天前
自动化与运维

CI/CD 自动化工程指南

为项目建立可验证、可回滚的持续集成与部署流水线。

★ 107k FS 48 谨慎使用 13 天前

相关 Skills