用途:对照源代码核验 API 文档,消除虚构的 API 方法、未经验证的性能声明、不可运行的代码示例与营销语言,要求文档中每个功能都真实存在于代码库。
主要能力(按核验类别): CRITICAL(提交前必须修复):API 方法存在性(文档方法须在源码中存在且签名精确一致);参数与返回类型须与实现完全一致,不得猜测;代码示例须可运行,含正确导入与错误处理;性能声明零容忍,须有基准测试支撑。 HIGH(应尽快修复):配置项须存在且字段名正确;所有抛出的错误须被记录。 MEDIUM(可选):移除营销用语(如 blazing-fast、revolutionary、enterprise-grade);依赖版本须与 package.json 完全一致。
使用方式:可手动调用,例如 /skill api-documentation-verify、/skill api-documentation-verify README.md 或 /skill api-documentation-verify docs/;也可在修改文档的提交前、CI/CD 文档 lint 步骤中、发布前调用。执行流程为:识别文档(.md、README、DOCS、API 文件)、提取声明(方法、示例、配置、性能声明)、对照源码核验、扫描营销用语、生成含行号的 CRITICAL/HIGH/MEDIUM 报告、给出关键问题的正确版本与统计。详细检查模式见 ~/.claude/skills/api-documentation-verify/references/VERIFICATION-CHECKS.md,详细执行步骤与报告格式见同目录 EXECUTION-STEPS.md。
适用场景:审查文档、文档提交前、CI/CD 文档校验、发布前确保文档准确。
限制:资料未提供具体安装命令、收费与价格信息;CRITICAL 问题应阻止文档提交。