SuperAPI AI 工具集

audit-docs

办公与效率

查看项目

更新于 10-15 21:56

技能介绍

用途:audit-docs 回答“文档是否仍与实际情况一致”,适用于发布或里程碑前、合并多个功能或修复后,或怀疑文档集已与代码和 issue 脱节时。运行方式为独立使用,无需前置技能,与创建文档的 unit-lane、维护修复索引的 triage-issue 互补。

主要能力:先发现项目结构(文档地图、路线图、修复索引与模板、功能目录布局),再执行最多 14 项机械检查:路线图与功能目录互相覆盖;功能依赖(SPEC 的 Depends on / Branch)有效、无环且顺序一致;修复索引卫生(条目对应开放 issue 与未合并分支,标记已关闭 issue 或已合并 PR 的条目);文档地图链接可解析;文档内相对链接与锚点有效;issue 引用未指向长期关闭的 issue;语言与命名约定一致;不变量标签(如 INV-/D-/KI-)存在性抽查;done 行 PR 链接完整性;阶段命名(用 P1、P2,不允许 S1、Step 1);每阶段文档纪律;分支与 PR 纪律(目标默认分支、正文非空、Closes #n);生成文档来源与陈旧页面;提交信息格式与依赖合并纪律。

使用方式:用 grep、文件读取与 forge CLI(示例为 gh)执行检查,最终打印固定格式报告,包含表格列:编号、检查项、发现、严重程度、证据、建议修复,以及执行数量、摘要与 Decision: PASS | FAIL(存在未解决 high 即 FAIL)。示例命令包括 grep -rnE '\bS[0-9]+\b|\bStep [0-9]' docs/features/*/{PLAN,TASKS,progress}.md 与 gh pr list --state all --head feat/<NN>-<slug>,以及 git log --first-parent。

限制与注意:只读优先,绝不未经提示批量重写文档;只在显式 --fix 或用户同意后应用低风险修正(删除已合并的修复索引行、修复失效链接、登记缺失的路线图条目、为 bare done 行补已验证 PR 链接),判断性修改留给用户。需区分真实漂移与有意“scheduled/deferred”项,不把权衡报告为错误;修改须最小化且限于文档,不改代码或行为。仅定义 high(误导或损坏)与 low(外观性)两级。缺失结构跳过检查并说明。其他 agent 上若缺少斜杠命令或模型配置,按回退方式打开 SKILL.md 并遵循。审查者应使用足够强的模型,机械检查中中等模型即可。功能、收费、价格与平台细节暂未提供。