SuperAPI AI 工具集

documentation-automation

办公与效率

查看项目

更新于 10-15 21:36

技能介绍

用途:在编码过程中主动维护项目文档,让变更同步反映到 CHANGELOG.md、各 README 文件、内联代码注释与交叉引用中。

触发时机:完成新功能、修复缺陷、引入破坏性变更、新增 API 端点或函数、大规模重构、完成用户故事或任务,以及重要工作提交 git 前。琐碎错字修复、未完成工作、无功能影响的清理不建议触发。

主要能力:一是维护根目录 CHANGELOG.md,采用 Conventional Commits 与语义化版本,条目归入 ## [Unreleased],使用 Added、Changed、Fixed、Deprecated、Removed、Security 分组,使用现在时、附带文件路径与 issue 编号(如 #123),破坏性变更给出迁移说明;二是按改动范围更新对应 README,补充功能列表、安装步骤、API、配置、示例与故障排查,保持既有语气与结构;三是为 Rust 的 pub 函数、结构体、枚举、模块及 TypeScript 导出添加文档注释,包含用途、参数、返回值、示例与安全说明;四是移动、重命名后更新交叉引用和文件路径引用。

使用方式:先用 git diff 分析改动范围与用户影响,再依次更新 CHANGELOG、相关 README、内联文档与交叉引用,最后核对格式一致性。可用资料中提供的 grep 与 git 命令查找未文档化的公开 API 和近期提交。

限制:触发条件与文档位置来自示例项目,实际路径需按项目调整;安全修复不得在 CHANGELOG 中披露漏洞细节;示例与代码片段需自行验证。其余平台、收费等信息暂未提供。