用途:把文档当作只读证据系统来审计,判断新贡献者、运维、用户或编码智能体能否找到正确来源、信任其声明并在无隐藏上下文的情况下行动。审查独立文档,以及承载公开或运维知识的代码注释。不用于代码、测试或架构审计。
主要能力:
- 范围与读者:识别入口文档、公开文档、维护者文档、运维手册、生成参考、示例与注释面,明确读者及其具体任务(理解、安装、配置、操作、排障、扩展、验证)。
- 结构与可发现性:检查根入口文档的目的、前置条件、安装路径与导航;标题、目录、交叉链接、锚点、大小写、孤立文档、重复入口、循环导航;概念是否只有一个权威出处。
- 相关度、覆盖与一致性:按文档类型判断内容(索引只路由、参考优化精确查找、操作指南安全排序、解释建立心智模型、决策记录保留上下文与后果);标记填充内容、过时计划、已完成 TODO、失效截图、术语不一致、矛盾与归属不清。
- 事实验证:抽取路径、文件、符号、版本、计数、命令、标志、环境变量、配置键、端口、端点、模式、默认值等声明,建立声明账本,对照当前仓库证据或安全命令核验;外部 API、弃用、安全标准用官方来源;在安全本地或一次性环境执行示例,否则静态验证。
- 注释与报告:检查注释与文档字符串的理由、不变量、契约、副作用、失败行为与不变量;核对公开接口签名、参数、返回、异常与可空性。
使用方式:按工具路由选择工具(文件枚举用窄模式原生列表;链接与声明用原生文本搜索再精读;代码真值用代码搜索、清单、模式与直接读取;新鲜度与归属用 git log、blame、diff;命令与示例用非变更或 dry-run 模式的 shell;外部事实用官方文档、规范、发布说明)。执行契约以有序复选框为完成定义,每项标记 PENDING、PROVEN(附具体证据)、CLEARED(附条件不存在的证据)或 UNPROVEN(附缺口),返回前解决全部 PENDING 并按技能规则给出结论。
限制:禁止运行发布、迁移、部署、写生产状态或重写文档的命令;生成缓存仅在允许且披露时可用。证据不足需标记未验证。仅当真实读者需要缺失知识时,缺失文档才构成发现项。问题按对错误行动、无法操作、维护漂移或轻微摩擦造成的危害分为 P0-P3;结论用 BLOCKED、FAIL、CONCERNS、PASS。报告按 Result、Scope、Evidence、Verification、Completion 五字段输出。
原文未提供具体安装命令、价格或平台信息。