SuperAPI AI 工具集

audit-docs

写作与研究

查看项目

更新于 10-16 03:11

技能介绍

用途:审计文档完整度。可用于一次功能分支之后、针对某个主题,或针对一组已有文档进行审计。流程是先扫描相关改动,再对照 Infrahub 的每一层文档,报告缺口,最后仅在用户批准后应用修复。目标是覆盖而不过度文档化:只有当读者确实缺少所需内容时才算缺口。

输入:$ARGUMENTS 为待审计对象,可能是提交区间或分支名、一个主题(如 webhooks、computed attributes、IPAM),或一组文档路径;为空时需询问要审计什么(默认当前分支对 stable)。

主要能力:对每个改动区域检查五层文档——技术参考(dev/knowledge/backend/ 或 frontend/)、用户文档(docs/docs/topics/ 或 guides/)、功能规格(dev/specs/)、变更日志(changelog/)、交叉引用(所有文档双向链接);并在相关时检查 architecture.md、testing.md、schema-definitions.md、backend/AGENTS.md 或 frontend/app/AGENTS.md 等次要位置。

使用方式:1)收集范围,可用 git log <range> --oneline --stat 查看每次改动,重点参考 PR 描述、PR 评审意见(含已解决与未解决)、变更日志片段与 spec 链接、源码 diff;2)将改动映射到各文档层;3)生成审计报告,含范围、改动摘要、文档状态(Current/Outdated/Missing/N/A)、缺口(缺少什么、改或建哪个文件、严重程度、建议修复)、以及“并非缺口(有意为之)”一节;4)应用修复前先询问用户选择全部、挑选或都不做;获批后优先编辑已有文件、双向检查交叉引用,并运行 uv run invoke docs.lint 做全局 Markdown/MDX 检查。

限制与守则:用户批准具体修复前绝不编辑文档,报告先行、写入是单独的可选步骤;如实报告“并非缺口”,理由充分说明有意缺失为何合理;每个缺口须落到具体读者需求与确切文件;优先编辑而非新建,除非没有已有文档适合承载内容。