---

name: documentation description: "文档生成工作流，涵盖API文档、架构文档、README文件、代码注释和技术写作。" category: workflow-bundle risk: safe source: personal date_added: "2026-02-27"

文档工作流套件

概述

全面的文档工作流，用于从代码库生成API文档、架构文档、README文件、代码注释和技术内容。

何时使用此工作流

在以下情况下使用此工作流：

• 创建项目文档
• 生成API文档
• 编写架构文档
• 为代码添加文档
• 创建用户指南
• 维护Wiki

工作流阶段

阶段1：文档规划

调用的技能

• docs-architect - 文档架构
• documentation-templates - 文档模板

操作步骤

1. 确定文档需求
2. 选择文档工具
3. 规划文档结构
4. 定义样式指南
5. 搭建文档站点

复制粘贴提示

Use @docs-architect to plan documentation structure

Use @documentation-templates to set up documentation

阶段2：API文档

调用的技能

• api-documenter - API文档
• api-documentation-generator - 自动生成
• openapi-spec-generation - OpenAPI规范

操作步骤

1. 提取API端点
2. 生成OpenAPI规范
3. 创建API参考
4. 添加使用示例
5. 设置自动生成

复制粘贴提示

Use @api-documenter to generate API documentation

Use @openapi-spec-generation to create OpenAPI specs

阶段3：架构文档

调用的技能

• c4-architecture-c4-architecture - C4架构
• c4-context - 上下文图
• c4-container - 容器图
• c4-component - 组件图
• c4-code - 代码图
• mermaid-expert - Mermaid图表

操作步骤

1. 创建C4图表
2. 编写架构文档
3. 生成序列图
4. 记录数据流
5. 创建部署文档

复制粘贴提示

Use @c4-architecture-c4-architecture to create C4 diagrams

Use @mermaid-expert to create architecture diagrams

阶段4：代码文档

调用的技能

• code-documentation-code-explain - 代码解释
• code-documentation-doc-generate - 文档生成
• documentation-generation-doc-generate - 自动生成

操作步骤

1. 提取代码注释
2. 生成JSDoc/TSDoc
3. 创建类型文档
4. 为函数编写文档
5. 添加使用示例

复制粘贴提示

Use @code-documentation-code-explain to explain code

Use @code-documentation-doc-generate to generate docs

阶段5：README和入门指南

调用的技能

• readme - README生成
• environment-setup-guide - 环境搭建指南
• tutorial-engineer - 教程创建

操作步骤

1. 创建README
2. 编写入门指南
3. 记录安装步骤
4. 添加使用示例
5. 创建故障排除指南

复制粘贴提示

Use @readme to create project README

Use @tutorial-engineer to create tutorials

阶段6：Wiki和知识库

调用的技能

• wiki-architect - Wiki架构
• wiki-page-writer - Wiki页面
• wiki-onboarding - 入职文档
• wiki-qa - Wiki问答
• wiki-researcher - Wiki研究
• wiki-vitepress - VitePress Wiki

操作步骤

1. 设计Wiki结构
2. 创建Wiki页面
3. 编写入职指南
4. 记录流程
5. 搭建Wiki站点

阶段7：变更日志和发布说明

调用的技能

• changelog-automation - 变更日志生成
• wiki-changelog - 从git生成变更日志

操作步骤

1. 提取提交历史
2. 分类变更
3. 生成变更日志
4. 创建发布说明
5. 发布更新

阶段8：文档维护

调用的技能

• doc-coauthoring - 协作写作
• reference-builder - 参考文档

操作步骤

1. 审查文档
2. 更新过时内容
3. 修复断开的链接
4. 添加新功能说明
5. 收集反馈

文档类型

代码级别

• JSDoc/TSDoc注释
• 函数文档
• 类型定义
• 示例代码

API文档

• 端点参考
• 请求/响应模式
• 认证指南
• SDK文档

架构文档

• 系统概述
• 组件图
• 数据流图
• 部署架构

用户文档

• 入门指南
• 用户手册
• 教程
• 常见问题

流程文档

• 运维手册
• 入职指南