SuperAPI AI 工具集

verify-docs-findable

通用与其它

查看项目

更新于 10-15 21:06

技能介绍

用途:衡量仓库文档“可检索性”而非“完整性”。核心观点是完整不等于可找到:索引列全所有文档,读者仍可能绕多跳并回退到源码。做法是让从未见过仓库的冷读者仅凭文档回答问题,记录从索引起算的步数。

主要能力:组织 3 至 8 个反复出现、关键或被误述的问题(来源依次为本次会话中刚产生的困惑、文档声称提供的“标准答案”、由顶层主题推断或向用户询问);为每个问题并行启动一个 Haiku 验证智能体,要求仅使用文档、从索引开始、优先文档而非源码,并报告答案、出处文件、距索引步数、清晰或分散、是否被迫读源码。

使用方式:在一条消息中并行运行全部验证器;按正确性、步数(1-2 为佳,3+ 为缺口)、死胡同、是否需读源码、文档矛盾等信号评分,输出记分卡(问题|正确|步数|是否需源码|结论)和优先修复清单;随后修复缺口(在索引加入“问题→唯一文档”指针、把事实写入单一权威文档、修正过时文档、调和矛盾),再对最差问题重跑以测量步数是否下降。

适用场景:文档重组后审计;需要验证陌生贡献者能否仅靠文档找到答案。

限制与说明:依赖 Haiku 且无上下文的智能体,模型选择是方法的一部分;结果依赖问题集质量,问题集建议保存在仓库(如 docs-findability-questions.md)以便重复审计。除上述流程外,具体安装命令、收费、价格与平台信息暂未提供。