SuperAPI AI 工具集

aicr-auditing-docs

写作与研究

查看项目

更新于 10-16 07:24

技能介绍

用途:对 AICR 的 Markdown 文档做可重复的审计,而非重写。适用于周期性文档健康检查、发布前检查、大型功能合并后(新增 CLI 标志、API 端点、组件、recipe 字段),以及同一解释出现在多个文件疑似漂移时。不适用于撰写单篇新文档,也不适用于生成内容(docs/conformance/、docs/user/container-images.md)。

审计地图与归属:根 README.md 负责项目介绍、特性、支持环境;docs/user/ 负责用户操作与参考(cli-reference.md 拥有标志,任务叙述归任务文档);docs/integrator/ 负责集成与嵌入;docs/contributor/ 负责项目内部(架构总览为 contributor/index.md);demos/ 仅 GitHub;CONTRIBUTING.md、DEVELOPMENT.md、RELEASE.md、SECURITY.md 各管一事,交叉链接而非重复;.claude/CLAUDE.md 为规范,AGENTS.md 为 CI 同步镜像(不要标记为重复)。

事实来源(漂移热点):组件/图表/镜像版本以 docs/user/container-images.md 为准(由 make bom-docs 重新生成);工具版本以 .settings.yaml 为准;标准/枚举值以 Go 类型为准(如 pkg/recipe/criteria.go);API 形态以 api/aicr/v1/server.yaml 为准。

五个审计维度:重复、重叠/错位、臃肿、缺口(Diátaxis 四类是否齐全)、陈旧/风格违规。仓库文档风格规则:自动锚点、不写手工目录;谨慎将加粗标签提升为标题;重命名或删除标题时全仓 grep 旧锚点并修复入站链接,docs/** 的 PR 会经 lychee 检查锚点。

运行方式:按区域并行,每个目录树派一个研究代理,给出五个维度与事实来源清单,要求不超过 600 字的报告;汇总为一份按优先级排序的报告,先版本/枚举漂移,再重复合并,最后臃肿与缺口。默认只报告;若要求修复,每个主题一个聚焦 PR,改动后运行 make qualify(lychee 单独运行)。

常见错误:把 AGENTS.md 与 CLAUDE.md 镜像当作重复;建议加目录;手工改示例中的版本;直接编辑生成文件;孤立审计单个文件。