关于 audit
用于按一组规则全面审查工作的技能,负责确定审查范围、调用各项审查技能并合并结果。它按严重程度和影响排序问题,生成带编号的报告,并等待用户选择后再修复。
主要功能
- 01明确审查范围
- 02读取项目自身规则
- 03运行多项审查技能
- 04按根因合并问题
- 05排序并编号修复项
适用场景
- 01审查未提交的代码变更
- 02汇总多个规则检查结果
- 03整理需要优先处理的问题
- 04根据用户选择修复问题
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ raphaelsalaja/ skills --skill audit安装后在 Claude Code 中输入/audit确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
report.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 | 检查每个标签、描述和状态文本 |
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。