SuperAPI AI 工具集

audit

测试与质量

查看项目

更新于 10-16 07:07

技能介绍

审计(Audit)是一个后端质量综合评估工具,作为 axiom 系列的锚点技能,负责编排其他 axiom 技能,产出统一的后端质量报告。

主要用途

  • 评估整体代码库或模块的健康状况。
  • 为发布或大规模重构做准备。
  • 通过入职评估了解既有技术债。
  • 当用户说出「audit」「full quality check」「assess quality」等指令时触发。

不适用的情况:针对某一特定关注点时,应直接使用 axiom:critique、axiom:harden、axiom:distill 或 axiom:verify;仅运行确定性检查时,应使用 axiom:scan;执行特定工作流审查时,由工作流工具来编排 axiom 而非反向调用。

处理流程

  1. 范围解析(Scope Resolution):根据 scope 参数确定评估范围,可以是单个文件、目录(递归)或整个代码库(默认为当前工作目录)。默认排除 node_modules/、dist/、.git/、二进制文件与生成文件。
  2. 确定性扫描(Deterministic Scan):以 dimensions: all 对已解析范围运行 axiom:scan,产出支撑定性评估的机械性发现项。
  3. 定性评估(Qualitative Assessment):按顺序运行各专项技能并传入范围,包括 axiom:critique(架构 DIM-6 + 拓扑 DIM-1)、axiom:harden(可观测性 DIM-2 + 弹性 DIM-7)、axiom:distill(卫生 DIM-5 + 拓扑 DIM-1)、axiom:verify(测试保真度 DIM-4 + 契约 DIM-3)、axiom:humanize(文本质量 DIM-8)。各技能按标准格式产出发现项。
  4. 去重与聚合(Deduplicate and Aggregate):按规则合并各技能的发现项——相同证据且相同维度合并为单条(保留最详细说明);相同证据但不同维度则均保留;相同模式但不同文件各自保留;同一问题的确定性检查与定性评估结果合并,并标记 deterministic: true。
  5. 覆盖检查(Coverage Check):确认全部 8 个维度均已评估。若某维度既无发现项也无检查,则给出警告「DIM-N ({name}) was not assessed — no checks or findings produced」,这可能表示该范围不包含与该维度相关的代码。
  6. 计算结论(Compute Verdict):严格依据 @skills/backend-quality/references/scoring-model.md 中定义的结论进行计算,不在本处重新定义阈值,仅计算并报告模型所需的输入(HIGH/MEDIUM/LOW 计数)。同时计算各维度指标:通过率(仅确定性检查)、发现项数量(全部发现项)、严重度分布(HIGH/MEDIUM/LOW)。
  7. 产出报告(Produce Report):按 scoring-model.md 中的模板输出结构化报告,包含 Scope、Verdict(CLEAN | NEEDS_ATTENTION)、Date,以及 Summary(各维度发现项、严重度计数、通过率表格)、HIGH-Priority Findings、MEDIUM-Priority Findings、LOW-Priority Findings、Dimensional Coverage、Recommendations(3-5 项优先行动项)。

错误处理

  • 空范围(无可评估文件):返回「Nothing to assess — no files found in scope」,结论为 CLEAN。
  • 部分技能失败:若某个技能出错,继续运行其余技能,并在输出中报告「axiom:{skill} encountered an error: {message}. Results from other skills are still valid.」
  • 范围校验:开始前先确认文件/目录存在,若不存在则返回「Scope not found: {path}」。

组合说明与参考

关于 audit 如何发现技能、处理去重与格式化报告的细节,参见 @skills/audit/references/composition-guide.md。 相关参考:维度分类法 @skills/backend-quality/references/dimensions.md;发现项格式 @skills/backend-quality/references/findings-format.md;评分模型 @skills/backend-quality/references/scoring-model.md;组合细节 @skills/audit/references/composition-guide.md。

限制

上述资料未提供关于收费、价格、具体支持平台或量化效果的说明,相关内容暂未提供。具体阈值与结论定义以 scoring-model.md 为唯一来源,本文不重复定义。