关于 audit
audit 按项目规则和设计技能集合检查指定范围,并将有证据支持的问题合并为分级报告。它面向代码或界面工作的审查,负责确定范围、安排检查、整合发现和给出结论,不负责具体界面规则。
主要功能
- 01明确审查范围
- 02优先读取项目规则
- 03运行并记录相关技能检查
- 04按根本原因合并问题
- 05排序修复项并生成报告
适用场景
- 01审查未提交的差异或拉取请求
- 02对照改动检查会话请求
- 03按设计技能审查代码库
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ playful-design/ router --skill audit安装后在 Claude Code 中输入/audit确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
LICENSEreport.htmlreport.mdagents/openai.yaml详细介绍
审计
此技能会同时依据本合集中的每条规则审查工作。它会将每项问题交由负责该问题的技能处理,并将结果合并为一份按优先级排序的报告。
报告,而非规则
此技能不负责任何界面规则。它负责确定范围、审查顺序、整合结果并给出结论。每条发现都要引用负责该问题的技能中的规则 ID。发现必须有代码、运行中的应用或对话内容作为依据,不能仅凭个人喜好。
报告格式见 report.md。
1. 说明范围
明确要审查的内容:未提交的差异、一个分支、一个拉取请求、本次会话中的请求,或整个代码库。未说明范围的审计属于 audit-state-the-scope。
2. 阅读项目规则
阅读 AGENTS.md、CLAUDE.md 和编辑器规则文件夹。项目的书面规则优先于此处的默认规则。将遵循书面规则的代码标记为问题,属于 audit-project-rules-first。
3. 运行每项技能
依据每项技能检查范围,并记录检查过的内容。
| 技能 | 检查内容 |
|---|---|
verify | 在运行中的应用中打开每个已更改的界面 |
scope | 对照差异检查对话中的每项请求 |
reuse | 对照共享包检查新增组件、样式和图标 |
restraint | 检查未经请求的 UI、设置、回退方案、死代码和叙述性注释 |
copy | 检查每个标签、描述和状态字符串 |
prose | 在写作属于范围时,检查每篇已更改的文章、分析或设计说明 |
defaults | 检查界面、类型、声音、焦点、名称、表单、加载、快捷键和对话框 |
motion | 检查每个过渡、动画、手势、退出效果和动态模糊 |
color | 检查每种主题下的文本和字段对比度、组件内的令牌以及强调色 |
gather | 检查每个参考板的平台、链接和需要借鉴的部分 |
match | 在工作参考了具名范例时,检查每个具名范例 |
rule | 检查没有书面规则的重复修正,以及违反规则的编辑 |
viewports | 在布局属于范围时,检查每种已更改布局在所有宽度下的表现 |
ship | 在 git 属于范围时,检查遗留文件、机密、提交和检查项 |
未说明原因就跳过某项技能,属于 audit-run-every-skill。
4. 按根本原因合并
同一个原因违反两项技能的规则时,应合并为一条发现,并列出两个 ID。同一个局部修复对应的五个调用位置,应合并为一条发现,并列出五个位置。将每个症状单独列出,属于 audit-one-row-per-cause。
5. 为修复编号并打开报告
先按严重程度、再按影响范围排列发现。为它们编号,让用户可以回复“修复 1、2 和 5”。
将 report.html 复制到 .audit/<scope>/index.html,这是一个被忽略的文件夹,不能放进源代码树。在旁边按其头部注释所示的结构编写 report.js,然后打开报告。
报告的外观由此技能提供,因此只编写数据。自行编写带有标记或样式的报告页面,属于 audit-shipped-report。
用户会使用 Pick 标记发现,再通过 Copy Picks 复制结果并发回。等待用户选择,然后只修复选中的编号。用户选择之前就修复所有问题,属于 audit-fix-what-was-picked。
配对
每项检查都要成对呈现:问题所在的行旁边是替换它的行。
| 规则 | 问题示例 | 替换示例 |
|---|---|---|
audit-state-the-scope | “已审计应用” | “已审计未提交的差异:14 个文件” |
audit-project-rules-first | 在规则要求保留边框的代码库中将边框标记为问题 | 引用项目规则,不列出问题 |
audit-run-every-skill | 悄悄跳过 copy | “copy:没有字符串变更” |
audit-one-row-per-cause | 一个缺失的基础元素列出五行 | 一行,五个位置 |
audit-shipped-report | 从头编写报告页面 | 复制 report.html,只编写 report.js |
audit-fix-what-was-picked | 未经用户选择就修复全部 18 条发现 | 只修复用户选中的编号 |
报告
使用 report.md 中的严重程度阶梯和格式。仍有任何 HIGH 时,结论为 Block;否则为 Approve。绝不要对你没有打开或阅读过的工作给出 Approve。