用途:当检测到文档漂移时,documentation-audit 会全面审计代码库,创建或更新 Swagger/OpenAPI、功能文档及通用文档,使文档与代码保持一致。其核心原则是文档必须反映现实。
主要能力:分阶段执行审计。发现阶段查找所有文档文件、API 文档和功能文档;API 审计阶段检测 API 框架(express、fastify、nestjs、fastapi、flask、go)并从代码中提取端点;功能审计阶段查找面向用户的组件、功能标志和配置项;生成阶段在缺失时创建 OpenAPI 模板和功能文档模板;更新阶段为已发现但未记录的端点或功能补充条目;验证阶段校验 YAML/JSON 有效性、检查 Markdown 章节完整性并对比代码与文档中的端点数量。最后生成审计报告,可发布到 GitHub issue。
使用方式:该技能由 api-documentation、features-documentation 或 issue-driven-development 在检测到漂移时调用,也可由用户或编排器手动请求。开始时会声明正在使用 documentation-audit 同步文档。使用 Glob/Grep 发现代码产物,Read 分析现有文档,Write 创建新文档,Edit 更新现有文档,yq 校验 YAML,jq 校验 JSON。
适用场景:适用于 API 文档漂移、功能文档漂移、文档文件缺失或需要全面同步文档的代码库。
限制:生成的内容包含占位符,需要人工审查和增强描述、补充示例并验证响应模式;未知框架需手动检查;文档质量依赖代码中可提取的信息,缺失事实暂未提供。