关于 audit-agents
用于审查 AGENTS.md 的文档审计技能,面向维护项目指南的团队。它按长期价值、可操作性、归属和迭代速度评估每一行,并按优先级给出原文和修改建议;仅在收到请求时编辑。
主要功能
- 01审查 AGENTS.md,不运行构建或测试
- 02判定保留、改写、移动或删除
- 03检查内容的持久性与可操作性
- 04依据示例检查文档结构
- 05按优先级列出原文和修改建议
适用场景
- 01评估贡献者指南是否长期有效
- 02找出 AGENTS.md 中应归档到别处的细节
- 03删除重复或不可操作的规则
- 04收到明确请求后重写指南
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ dzhng/ skills --skill audit-agents安装后在 Claude Code 中输入/audit-agents确认已加载。
附带文件assets/example-agents.md
详细介绍
审计 Agent
AGENTS.md 会被所有曾参与项目工作的人阅读。想象未来一百年里的一千位贡献者:只有当每个文件、工具和依赖都已更换之后,一行内容仍然成立、仍然会改变他们的做法,它才值得保留。
工作流
- 阅读 AGENTS.md 和根目录的 readme。这是文档审计:不要运行构建或测试。
- 根据以下标准,为每一行给出一个判定。
- 保留:通过所有标准的原则。
- 改写:将长久有效的经验用当下的机制表述,或把过于含糊、无法付诸行动的内容说清楚。
- 迁移:有人需要的细节。指出它应归属的位置:readme、清单、技能或规范。
- 删除:重复内容、历史记录,或不会改变任何事情的内容。
- 对照下方示例检查结构。
- 按影响从高到低报告发现。引用每一行,给出判定和替换文本,并将重复内容归为一组。不要报告无法引用的发现。
- 只有用户要求重写时才进行编辑。届时从示例开始,写入文件,并以对本次会话毫无背景的新手身份重新阅读。
行的检查标准
- 一百年后仍然适用。 不要写命令、标志、路径、文件或函数名、依赖选型、调优数值、计划、状态或 bug 故事。保留经验,并将机制细节迁移到其归属位置。唯一的例外是指向归属位置(readme 或技能)的链接,这类链接是为了让细节能放在那里。
- 适用于一千人。 新手不需要了解本次会话、作者或本月的工作,就能据此行动。
- 能改变做法。 删除有能力的贡献者本来就会遵守的内容。
- 朴实具体。 原则不能是抽象概念。“看图”行得通;“让验证与声明相匹配”则不行。优先使用简短且说明后果的句子,并以产品中的一个例子代替泛泛而谈的名词。
- 迭代速度。 这是核心原则,必须明确写出:优化获得可信反馈所需的时间,运行能回答问题的最小范围检查,并在规范的实现完成后运行一次全部检查。标记任何会在每轮迭代中增加流程、要求在提交、合并、推送或功能完成前运行全部检查,或沿途设置检查点的规则。只有当下一项工作若缺少完整检查便无法获得可信结果时,才提前运行全部检查。绝不要为了速度牺牲真正的验收要求。
结构
assets/example-agents.md 是任何项目都可采用的 AGENTS.md,并规定了章节顺序。评判结构或重写之前,先阅读它。
要采用它,请复制该文件并替换每个 <…>;项目文件中不得残留任何占位符。
<skill: name>指本技能随附套件中的一项技能。将其替换为指向项目安装该技能位置的链接。如果项目没有这项技能,就删除该链接,保留原则。<skill: the project's own …>表示只有该项目才有的一项技能。为其添加链接,或删除整句话。- 其他所有
<…>均根据项目的 readme 填写。
删除项目不需要的章节;只有在某项原则无处可放时,才添加章节。
评论
支持 Markdown