SuperAPI AI 工具集

docs-update

写作与研究

查看项目

更新于 10-15 20:14

技能介绍

用途:在代码变更后同步更新文档,避免文档与实现脱节。适用于新增 TUI 快捷键、新增 CLI 命令或参数、新增配置项、修改默认行为、新增功能或集成、修改面向用户的功能等场景。

主要能力:引导识别受影响的文档变更,定位相关文档文件,更新 README.md 中的默认快捷键、TUI 功能、配置选项表和 CLI 参考,更新 docs/recipes/*.md 中的集成相关内容,并验证更新准确性后单独提交文档变更。

使用方式:先分析变更,可用 git diff 查看未提交改动,用 git log -5 --oneline 和 git show <commit-sha> 查看近期提交,用 git diff HEAD~1 internal/tui/model.go 查看指定文件差异,重点寻找 TUI 新快捷键、CLI 新命令、新配置字段、变更的默认值和新功能。再查找文档,可用 find . -name ".md" -not -path "./agent-deck/" | head -20 列出文档,用 grep -r "keybindings" README.md docs/ 等搜索内容。随后更新 README.md 的快捷键、功能、配置选项表和 CLI 参考,以及相关 recipe。验证时用 grep 搜索旧引用并确认新功能已记录。最后用 git add README.md docs/ 和 git commit -m "docs: ..." 单独提交文档。

限制:资料未提供该技能的安装方式、依赖、收费、平台支持或自动化程度等细节,暂未提供。