SuperAPI AI 工具集

doc-sync

写作与研究

查看项目

更新于 10-15 23:31

技能介绍

用途:这是 IdeaVim 项目的文档同步技能,用于在代码变更后验证文档是否仍与代码一致,并更新过时内容。

主要能力:支持两种模式。模式 A 从文档出发,核对代码是否仍与文档描述相符;模式 B 从代码变更(如 git diff)出发,查找相关文档并更新。技能会先寻找可运行实现作为“事实基准”,再检查近期提交中的删除、弃用等破坏性变更,最后逐条比对文档中的代码示例、函数签名与参数名。

使用方式:可指定文档文件(如 doc/ideavim-mappings.md)或代码变更文件(如 MappingScope.kt)触发检查,也可要求检查整个 doc/ 目录。技能会运行 grep、git log、git show 等命令辅助分析,并输出包含已检查文件、发现的差异、所做更新和备注的报告。

适用场景:代码改动后需要确认文档是否失效;文档中的示例可能引用了已删除或改名的 API;需要批量核查 doc/ 目录与 README、CONTRIBUTING 等文档的准确性。

限制:该技能面向 IdeaVim 项目,依赖项目内的代码与文档结构;具体可用工具、命令与输出格式以资料所述为准,其他环境或项目的适配情况暂未提供。