SuperAPI AI 工具集

documentation-audit

写作与研究

查看项目

更新于 10-16 02:33

技能介绍

用途:当检测到文档与代码不一致(文档漂移)时,对代码库进行全面审计,创建或更新 API 文档(Swagger/OpenAPI)、功能文档和通用文档,使文档反映当前代码现实。触发场景包括 API 文档漂移、功能文档漂移、缺少文档文件,或由用户/编排器手动请求。

主要能力:分阶段执行审计。发现阶段查找所有文档文件、定位 API 与功能文档;API 审计阶段识别 API 框架(express、fastify、nestjs、fastapi、flask、go 等)并从代码中提取端点;功能审计阶段查找面向用户的组件、功能开关与配置项。若缺少文档则生成 OpenAPI 模板与 features 文档模板;对已发现但未记录的端点和功能,补充路径、方法、参数、请求/响应模式与基础描述。验证阶段用 yq 校验 YAML、用 jq 校验 JSON,并检查 Markdown 标题与文档完整性。最后生成审计报告并发布到 GitHub issue。

使用方式:该工具由 api-documentation、features-documentation、issue-driven-development 等技能在检测到漂移时调用,也可手动触发。开始时会声明“I'm using documentation-audit to synchronize all documentation with the current codebase.”。依赖 Glob/Grep 发现代码、Read 分析现有文档、Write 创建新文档、Edit 更新文档,以及 yq、jq 校验。

适用场景:代码库出现文档漂移、缺少 API 或功能文档、需要系统化同步文档时。

限制:自动生成的内容仅为基础框架,需人工复核响应模式、完善功能描述、补充用法示例并校验安全文档;未知框架需手动检查;无法保证生成内容的业务准确性。具体收费、价格与平台支持情况暂未提供。