SuperAPI AI 工具集

validate-docs

写作与研究

查看项目

更新于 10-15 21:42

技能介绍

用途:回答“我的文档还准确吗”,在生成文档(generate-docs)与更新文档(update-docs)之间充当检查环节,避免 update-docs 全量扫描。

主要能力:先列出 docs/ 下的模块、功能文档及 overview.md;再用 git log -1 --format=%aI -- <doc> 获取每个文档最后修改时间;只读模块文档的 ## Structure 段提取源码路径;用 git log --since="<doc_timestamp>" --oneline --stat -- <source_path> 判断源码是否变化,从而标记模块为 Current/Stale/Missing;检查 overview 的模块列表与包清单变化;依据模块过期结果推断功能文档状态;最终在对话中输出含摘要、模块表、功能表、overview 表和建议动作的报告。

使用方式:由主智能体直接运行,不需子智能体,也不读取源码文件,只读 frontmatter 和特定段落。典型场景:运行 update-docs 前缩小范围、会话开始评估文档健康、用户询问文档是否最新、提交若干次后检查。若 docs/ 不存在则提示改用 generate-docs。

限制:只依据 git 元数据,不依赖文件系统时间戳或 frontmatter 版本;报告为临时对话内容,不写入文件;不更新任何文档;建议而非执行;整个检查应在 10 次工具调用内完成;宁可误报过期也不漏报。