SuperAPI AI 工具集

doc-sync-automation

编程与开发

查看项目

更新于 10-15 23:49

技能介绍

用途:在代码变更后同步更新文档,适用于更新文档、从代码生成 API 文档、创建或更新 README、维护内联注释/JSDoc,以及搭建文档自动化流程。

主要能力:按文档类型区分同步触发条件——内联 JSDoc/TSDoc 随代码变更、API 参考位于 /docs/api/ 随端点变更、README 随功能变更、CHANGELOG.md 随发布、架构文档位于 /docs/architecture/ 随结构变更。可生成 JSDoc 注释(含描述、@param、@returns、@throws、@example),批量更新文件内导出函数的注释;可从 Express 路由与校验 schema 生成 OpenAPI 3.1 规范;可更新 README 的安装、快速开始、配置、示例、要求等章节;可按 Keep a Changelog 格式从提交记录生成变更日志,分类为 Added、Changed、Deprecated、Removed、Fixed、Security。

使用方式:以提示词方式让 AI 生成或更新对应文档,例如提供函数代码要求生成 JSDoc、提供路由与 schema 要求生成 OpenAPI、提供提交列表要求生成 changelog。自动化方面可配置 husky 预提交钩子执行 npm run docs:check,或使用 GitHub Action 在 push 到 main 且改动 src/、docs/ 时运行 npm run docs:generate 并提交文档。文档与代码的组织可采用同目录放置、中心文档加引用、或从代码生成三种模式。

验证:可用 npx markdown-link-check 检查失效链接、npx @redocly/cli lint 校验 OpenAPI、npx ts-node 运行文档示例脚本。

限制:资料未提供具体安装命令、收费与价格、支持平台、实际效果数据及完整实现细节,相关事实暂未提供。