SuperAPI AI 工具集

doc-claim-validator

写作与研究

查看项目

更新于 10-16 01:37

技能介绍

用途:校验文档中的可验证声明是否与代码库一致,补充 doc-maintenance 的结构性检查,专注语义准确性。适用时机包括重大代码变更后、发布前、开发者反馈文档有误时、周期性信任审计,以及运行 doc-maintenance 之后做更深检查。

主要能力:分四阶段。第 1 阶段用 python3 skills/doc-claim-validator/scripts/extract_claims.py [--json] [--root PATH] [--scope docs|manual|all] 从 markdown 确定性提取 file_path、command、code_ref、import、config、url、architectural 等声明,dependency 与 behavioral 由后续 AI 分析处理。第 2 阶段用 python3 skills/doc-claim-validator/scripts/verify_claims.py [--json] [--root PATH] [--claims-file PATH] [--check-staleness] 自动核验,并可加 --check-urls 启用 URL 检查。AI 辅助核验分四个验证器:依赖(Explore/haiku)、行为(general-purpose/sonnet,按文档文件批量)、架构(general-purpose/sonnet)、代码示例(general-purpose/sonnet),可并行启动。--check-staleness 做 git 漂移评分,按低/中/高标记可能过期声明。第 3 阶段按 P0–P4 严重度及 missing_target、wrong_signature、stale_behavior、dead_dependency、phantom_pattern、wrong_integration、broken_example、dead_url、phantom_config 等类别汇总报告。第 4 阶段按情况更新文档、标记人工复核、删除声明或重写示例,并路由给 reference-builder、technical-writer、learning-guide。

限制:不自动修复行为类声明;不把每个行内代码都当文件路径;不校验归档文档;可选或条件功能标记为 conditional;默认不检查 URL,仅在启用时进行;不校验带 <!-- no-verify --> 的代码块。URL 检查需网络且较慢。