SuperAPI AI 工具集

audit-documentation-drift

写作与研究

查看项目

更新于 10-15 22:40

技能介绍

用途:判断文档是否仍准确描述其治理的系统,把文档漂移视为“声明一致性”问题——找出文档声明、找出权威证据、在相同修订与范围内比较,只报告已证实的脱节。

主要能力:区分规范性/契约文档、描述性文档、规划/历史、生成/派生文档与实现/测试/配置等角色;提取可测试声明(功能与公开行为、命令与参数、API、配置键与默认值、环境变量、架构职责与数据流、安装运维步骤、兼容性/版本/平台声明、可执行示例);对 CLI/配置密集型系统检查实际框架(如 Typer/Click 装饰器、解析器/schema、Pydantic 模型、常量);必要时执行安全的聚焦检查,仅在时间线能解释或定位问题时使用 git 历史。

分类:DOCUMENTED_NOT_IMPLEMENTED、IMPLEMENTED_NOT_DOCUMENTED、OUTDATED、MISMATCHED_DETAIL、IMPLEMENTATION_NONCONFORMANCE、UNCERTAIN。每条发现记录文档声明及位置、实现/契约证据及位置、修订或提交、分类、具体后果、修正面(文档/实现/生成器/权威决策)与置信度缺口。

使用方式:从请求中确定被审计项目/组件、文档面、修订/分支与环境变体,仅追问会改变结果的缺失范围;审计为只读,除非另有明确修复指令。按后果而非机械分类排优先级。输出结构为范围、发现、未解决覆盖/证据,必要时附时间线。

限制:不假设项目结构、文档范围或权威;不把规划/TODO 当作当前实现声明;不把测试当作绝对意图;未厘清生成关系不报告生成文件漂移;不从私有实现细节编造未文档化功能;当前状态比较可解决时不进行大范围 git 考古;未指明哪个权威面有误或未决前不给出修正建议。持久化、工件注册、编排状态与调用方返回封装不属于本分析范围。