SuperAPI AI 工具集

doc-sync

写作与研究

查看项目

更新于 10-16 00:30

技能介绍

doc-sync 是面向 IdeaVim 项目的文档同步技能,用于在代码变更后核对文档是否仍然准确,并在必要时更新文档。

用途:保持 IdeaVim 文档与代码变更同步,识别文档与代码之间的差异。适用于代码改动后验证文档准确性,或检查文档中的示例是否仍可用。

主要能力:支持两种模式。模式 A 从文档出发,验证代码是否仍与文档描述一致;模式 B 从代码变更(如 git diff)出发,找到相关文档并按需更新。文档位置包括 doc/ 文件夹、README.md 和 CONTRIBUTING.md。

使用方式:先建立“基准事实”,查找可运行实现(如搜索 @VimPlugin、@Plugin、class.*Extension),用 git log、git show 检查近期提交与删除内容,再提取文档中的代码示例与函数签名,逐一与当前 API 和可运行实现比对,最后按需修改文档并输出同步报告。可用工具包括 Read、Edit、Glob、Grep 和 Bash。

限制与原则:仅在 API 签名变化、名称重命名、行为根本改变、功能增删、文件路径失效或示例无法运行时更新;仅内部实现变化、措辞可优化但仍准确、格式不一致等情况不更新。查找问题要积极,修改要保守,保持原有文档风格,只做针对性修改。资料未提供具体安装命令、收费方式或平台信息。