SuperAPI AI 工具集

skill-validator

测试与质量

查看项目

更新于 10-15 10:53

技能介绍

用途

skill-validator 用于确保 Claude Code 技能达到既定质量标准,通过系统化的验证操作对技能进行把关。与 review-multi(提供 1-5 分评分)不同,skill-validator 针对生产部署的最低标准给出通过/不通过的判定,是技能部署的质量门禁。

主要能力:4 项验证操作

操作 1:验证结构

确保技能结构满足部署的最低标准。通过标准(须全部满足):YAML frontmatter 有效且包含必填字段(name、description);name 为 kebab-case 格式;description 至少包含 3 个触发关键词;SKILL.md 存在;文件命名符合约定;无严重结构违规。流程:运行自动化验证 python3 review-multi/scripts/validate-structure.py <skill>,检查得分须 ≥4 方可通过,确认无严重问题,记录通过/失败。判定:结构得分 ≥4 为 PASS,<4 为 FAIL。耗时 5-10 分钟(自动化)。

操作 2:验证内容

确保必要的内容章节与示例存在。通过标准(须全部满足):存在 Overview/Introduction 章节;存在 When to Use 章节且至少包含 3 个场景;存在主要内容(工作流步骤、操作或参考);至少 3 个示例(代码/命令);存在某种形式的最佳实践或指导。流程:检查 Overview 章节(## Overview 或 ## Introduction);检查 When to Use 章节及场景;确认主要内容存在;统计示例数量(查找 ``` 代码块,至少 3 个);检查 Best Practices、Common Mistakes 或指导章节。判定:5 项标准全部满足为 PASS,任一缺失为 FAIL。耗时 10-15 分钟(人工检查)。

操作 3:验证模式

确保架构模式被正确实现。通过标准(依模式而定):工作流类技能需有顺序步骤、步骤结构一致、存在前置条件或后置工作流章节;任务类技能需有 Operations 章节、操作结构一致、操作相互独立(无强制顺序);参考类技能需按主题组织、存在 Quick Reference。流程:识别模式类型(workflow/task/reference);检查该模式对应的标准;确认模式一致性;记录合规情况。判定:模式正确实现为 PASS,违反模式为 FAIL。耗时 10-20 分钟(人工检查)。

操作 4:验证生产就绪度

对部署就绪度进行综合的通过/失败检查。通过标准(须全部满足):结构验证通过(操作 1);内容验证通过(操作 2);模式验证通过(操作 3);无严重反模式(如 review-multi 可用则参考其结论);SKILL.md 完整(非存根或不完整);示例具体(非全部为占位符)。流程:运行操作 1-3;检查严重反模式(如单体 SKILL.md 超过 2,000 行且无引用、所有示例均为占位符、主要章节缺失);评估整体完整性;做出部署决定。判定:所有标准满足(可部署)为 PASS,存在任一严重问题为 FAIL。耗时 30-45 分钟(合并所有操作)。输出:DEPLOY 或 HOLD 决定。

使用方式

何时使用

  • 部署前门禁:发布前验证技能已就绪
  • 质量标准执行:确保所有技能达到最低标准
  • 持续集成:在构建/部署流水线中自动验证
  • 认证:认证技能符合生态标准
  • 更新后验证:确保变更未破坏合规性
  • 生态一致性:在所有技能间维持质量
  • 需要二元决策:发布或不发布(而非“得分多少”)

验证报告格式

报告包含验证日期、验证人,以及四项操作的结果:操作 1 结构验证(YAML、文件、命名、结构得分 X/5);操作 2 内容验证(Overview、When to Use 场景数、主要内容、示例数、指导);操作 3 模式验证(模式类型、实现正确性、一致性);操作 4 生产就绪度(READY TO DEPLOY 或 HOLD)。最后给出部署决定:DEPLOY(全部验证通过,可投入生产)或 HOLD(须修复严重问题,逐条列出问题及修复方式)。

与 review-multi 的集成

两者可配合使用:skill-validator 负责通过/失败与部署门禁;review-multi 负责 1-5 评分、综合评估与改进建议。工作流:构建技能 → skill-validator(是否 PASS?)→ review-multi(得分?)→ 若 PASS 则部署,并记录来自 review-multi 的改进建议。

最佳实践

  1. 部署前验证:对所有技能在生产部署前运行 skill-validator,将其纳入部署清单。
  2. 作为质量门禁:技能必须通过验证才能部署,无例外。
  3. 尽可能自动化:使用 review-multi 自动化进行结构验证,先运行 validate-structure.py。
  4. 清晰记录失败:技能失败时明确指出需修复的内容,列出具体问题与修复步骤。
  5. 修复后重新验证:修复问题后再次运行验证以确认,形成“验证 → 修复 → 再验证”循环。

最低标准速查

  • 结构:有效 YAML 含 name + description;name 为 kebab-case;3+ 触发关键词;SKILL.md 存在;基本文件结构。
  • 内容:Overview 存在;3+ When to Use 场景;主要内容存在;3+ 示例;有指导/最佳实践。
  • 模式:正确的模式实现;结构一致;满足模式特定要求。
  • 生产:所有验证通过;无严重反模式;完整(非存根);示例具体。

部署决策树

运行验证操作 1-4 → 是否全部 PASS?是则 DEPLOY(生产就绪);否则判断哪项失败:结构失败则修复 YAML/文件(严重);内容失败则补充缺失章节(严重);模式失败则修复实现(严重);修复后重新验证,通过则部署。

限制

资料未提供该工具的安装方式、收费模式、支持平台及具体运行环境要求,暂未提供相关信息。