用途:为代码库自动生成全面文档,减少手工编写成本。主要能力包括代码分析(提取 API、函数、类、类型与依赖)、API 文档生成(OpenAPI、JSDoc、TypeDoc、Python docstring)、README 生成、上下文感知的内联注释补充,以及基于 Graphviz/Mermaid 的架构与流程图生成。
使用方式:提供基础命令如 /doc-generate、/doc-api、/doc-readme、/doc-inline、/doc-diagrams;高级用法示例为 npx claude-flow docs generate --format openapi --output docs/api.yml、npx claude-flow docs generate --files "src/**/*.js" --type jsdoc、npx claude-flow docs update --incremental、npx claude-flow docs validate --min-coverage 80。
流程:按 SPECIFICATION、PSEUDOCODE、ARCHITECTURE、REFINEMENT、COMPLETION 五阶段推进,涵盖需求分析、结构设计、生成管线、生成校验与 CI/CD 集成(含 pre-commit 钩子检查文档覆盖率)。
适用场景:需要为 REST API、TypeScript/JavaScript 或 Python 项目补齐 API 参考、README、注释与架构图的团队。
限制:资料未提供具体安装命令、收费与价格、支持平台及实际效果数据;文档覆盖率目标与校验项为资料中列出的建议标准,非保证结果。