关于 quality-auditor
Quality Auditor 是一项技能,供团队从 12 个加权维度评估代码库、工具和系统。它依据证据给出评分、识别风险,并将建议整理为改进路线图。
主要功能
- 01按 12 个加权维度评估
- 02基于证据的评分与发现
- 03按优先级制定改进路线图
- 04加强对 AI 生成代码的验证
适用场景
- 01依据质量基准审计代码库
- 02通过验证检查审查 AI 生成代码
- 03评估技术债务与系统风险
- 04按统一标准比较工具或框架
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ oakoss/ agent-skills --skill quality-auditor安装后在 Claude Code 中输入/quality-auditor确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/anti-patterns-guide.mdaudit-report-template.mdaudit-rubric.mddimension-rubrics.mdverification-gap-protocol.md详细介绍
质量审计员
概述
按照 12 个加权维度,以最高行业标准评估工具、框架、系统和代码库。生成基于证据的评分,识别反模式,并制定按优先级排序的改进路线图。通过验证差距协议对 AI 生成的代码进行额外审查,确保开发速度不会损害完整性。
**适用场景:**审计代码质量、审查 AI 生成的代码、按照行业基准为代码库评分、实施提交前质量门禁、比较工具或框架、评估技术债务。
**不适用场景:**无需评分的快速代码审查、仅针对风格的 lint 检查(请使用 linter)、功能实现、无需完整审计的常规 PR 审查。
快速参考
| 维度 | 权重 | 评估内容 |
|---|---|---|
| 代码质量 | 10% | 结构、模式、SOLID、重复、复杂度、错误处理 |
| 架构 | 10% | 设计、模块化、可扩展性、耦合/内聚、API 设计 |
| 文档 | 10% | 完整性、清晰度、准确性、示例、故障排查 |
| 易用性 | 10% | 学习曲线、安装难易度、错误消息、易用性 |
| 性能 | 8% | 速度、资源使用、缓存、包体积、Core Web Vitals |
| 安全性 | 10% | OWASP Top 10、输入验证、身份验证、机密、依赖项 |
| 测试 | 8% | 覆盖率(单元/集成/e2e)、质量、自动化、组织方式 |
| 可维护性 | 8% | 技术债务、可读性、可重构性、版本管理 |
| 开发者体验 | 10% | 配置难易度、调试、工具、热重载、IDE 集成 |
| 无障碍性 | 8% | WCAG 合规性、键盘导航、屏幕阅读器、认知负荷 |
| CI/CD | 5% | 自动化、流水线、部署、回滚、监控 |
| 创新性 | 3% | 新颖方法、前瞻性设计、独特价值 |
审计阶段
| 阶段 | 名称 | 目的 |
|---|---|---|
| 0 | 资源完整性 | 验证注册表与文件系统的一致性;若此阶段失败,审计即告失败 |
| 1 | 发现 | 阅读文档、检查代码、测试系统、审查辅助材料 |
| 2 | 评估 | 为每个维度评分,并提供证据、优势和不足 |
| 3 | 综合 | 执行摘要、详细评分、建议、风险矩阵 |
评分标准
| 评分 | 等级 | 含义 |
|---|---|---|
| 10 | 卓越 | 行业领先,树立新标准 |
| 8-9 | 优秀 | 大幅超出预期 |
| 6-7 | 良好 | 达到预期,但仍需改进 |
| 5 | 可接受 | 低于平均水平,需要大幅改进 |
| 3-4 | 较差 | 存在重大差距和根本性问题 |
| 1-2 | 严重 | 几乎无法运行或完全无法运行 |
常见错误
| 错误 | 正确做法 |
|---|---|
| 没有证据却给出虚高的分数 | 每项评分都必须引用具体文件、指标或代码示例作为证据 |
| 跳过阶段 0 的资源完整性检查 | 务必先验证注册表是否完整;缺少资源会将总分限制在 6/10 |
| 只评估代码质量,忽视其他维度 | 按适当权重评估全部 12 个维度;架构、安全性和开发者体验同样重要 |
| 接受流于表面的“LGTM”审查 | 深入进行语义审计,检查契约完整性、安全净化和性能规范 |
| 未经验证就信任 AI 生成的代码 | 执行验证差距协议:使用审查 Agent、设定可验证目标,并对关键路径进行人工监督 |
| 审计失败后未重新审计便继续 | 停止、分析偏差、进行修复,然后从第 1 步重新开始检查清单 |
| 没有非凡证据却给出 10/10 的分数 | 仅将 10/10 留给真正行业领先的成果;大多数质量工具的评分为 6-7 |
| 只进行表层静态分析 | 将代码检查与架构适配性检查、基于风险的 PR 分类以及上下文感知验证结合起来 |
委派
- 了解代码库结构并收集审计证据:使用
ExploreAgent 调查文件组织、依赖项、测试覆盖率和文档 - 执行针对性的多维度质量检查:使用
TaskAgent 运行代码检查工具、安全扫描器、性能分析器和无障碍审计 - 制定质量改进路线图:使用
PlanAgent 根据审计结果确定快速见效项、短期建议和长期建议的优先级
如需对 AI 生成的文本和代码进行风格清理(过度使用 em dash、低质词汇、注释过多、命名冗长),请使用
de-slopify技能。如果有
usability-tester技能,请委派给它评估可用性维度并验证用户流程。 否则,建议使用:pnpm dlx skills add oakoss/agent-skills -s usability-tester -a claude-code -y
参考资料
评论
支持 Markdown