Back to Details

documentation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Documentation Workflow Bundle

文档生成工作流套件

Overview

概述

Comprehensive documentation workflow for generating API documentation, architecture documentation, README files, code comments, and technical content from codebases.
一套全面的文档生成工作流，可从代码库生成API文档、架构文档、README文件、代码注释和技术内容。

When to Use This Workflow

何时使用此工作流

Use this workflow when:
  • Creating project documentation
  • Generating API documentation
  • Writing architecture docs
  • Documenting code
  • Creating user guides
  • Maintaining wikis
在以下场景使用此工作流：
  • 创建项目文档
  • 生成API文档
  • 编写架构文档
  • 为代码添加文档
  • 创建用户指南
  • 维护维基知识库

Workflow Phases

工作流阶段

Phase 1: Documentation Planning

阶段1：文档规划

Skills to Invoke

调用技能

  • docs-architect
    - Documentation architecture
  • documentation-templates
    - Documentation templates
  • docs-architect
    - 文档架构设计
  • documentation-templates
    - 文档模板

Actions

操作步骤

  1. Identify documentation needs
  2. Choose documentation tools
  3. Plan documentation structure
  4. Define style guidelines
  5. Set up documentation site
  1. 确定文档需求
  2. 选择文档工具
  3. 规划文档结构
  4. 定义风格指南
  5. 搭建文档站点

Copy-Paste Prompts

可复制粘贴的提示词

Use @docs-architect to plan documentation structure
Use @documentation-templates to set up documentation
Use @docs-architect to plan documentation structure
Use @documentation-templates to set up documentation

Phase 2: API Documentation

阶段2：API文档生成

Skills to Invoke

调用技能

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

Actions

操作步骤

  1. Extract API endpoints
  2. Generate OpenAPI specs
  3. Create API reference
  4. Add usage examples
  5. Set up auto-generation
  1. 提取API端点
  2. 生成OpenAPI规范
  3. 创建API参考文档
  4. 添加使用示例
  5. 配置自动生成机制

Copy-Paste Prompts

可复制粘贴的提示词

Use @api-documenter to generate API documentation
Use @openapi-spec-generation to create OpenAPI specs
Use @api-documenter to generate API documentation
Use @openapi-spec-generation to create OpenAPI specs

Phase 3: Architecture Documentation

阶段3：架构文档生成

Skills to Invoke

调用技能

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

Actions

操作步骤

  1. Create C4 diagrams
  2. Document architecture
  3. Generate sequence diagrams
  4. Document data flows
  5. Create deployment docs
  1. 创建C4图
  2. 编写架构文档
  3. 生成序列图
  4. 记录数据流
  5. 创建部署文档

Copy-Paste Prompts

可复制粘贴的提示词

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

Phase 4: Code Documentation

阶段4：代码文档生成

Skills to Invoke

调用技能

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

Actions

操作步骤

  1. Extract code comments
  2. Generate JSDoc/TSDoc
  3. Create type documentation
  4. Document functions
  5. Add usage examples
  1. 提取代码注释
  2. 生成JSDoc/TSDoc
  3. 创建类型文档
  4. 记录函数说明
  5. 添加使用示例

Copy-Paste Prompts

可复制粘贴的提示词

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

Phase 5: README and Getting Started

阶段5：README与快速入门指南

Skills to Invoke

调用技能

  • readme
    - README generation
  • environment-setup-guide
    - Setup guides
  • tutorial-engineer
    - Tutorial creation
  • readme
    - README生成
  • environment-setup-guide
    - 环境搭建指南
  • tutorial-engineer
    - 教程制作

Actions

操作步骤

  1. Create README
  2. Write getting started guide
  3. Document installation
  4. Add usage examples
  5. Create troubleshooting guide
  1. 创建README文件
  2. 编写快速入门指南
  3. 记录安装步骤
  4. 添加使用示例
  5. 创建故障排除指南

Copy-Paste Prompts

可复制粘贴的提示词

Use @readme to create project README
Use @tutorial-engineer to create tutorials
Use @readme to create project README
Use @tutorial-engineer to create tutorials

Phase 6: Wiki and Knowledge Base

阶段6：维基与知识库

Skills to Invoke

调用技能

  • wiki-architect
    - Wiki architecture
  • wiki-page-writer
    - Wiki pages
  • wiki-onboarding
    - Onboarding docs
  • wiki-qa
    - Wiki Q&A
  • wiki-researcher
    - Wiki research
  • wiki-vitepress
    - VitePress wiki
  • wiki-architect
    - 维基架构设计
  • wiki-page-writer
    - 维基页面编写
  • wiki-onboarding
    - 入职文档
  • wiki-qa
    - 维基问答
  • wiki-researcher
    - 维基资料调研
  • wiki-vitepress
    - VitePress维基

Actions

操作步骤

  1. Design wiki structure
  2. Create wiki pages
  3. Write onboarding guides
  4. Document processes
  5. Set up wiki site
  1. 设计维基结构
  2. 创建维基页面
  3. 编写入职指南
  4. 记录流程文档
  5. 搭建维基站点

Copy-Paste Prompts

可复制粘贴的提示词

Use @wiki-architect to design wiki structure
Use @wiki-page-writer to create wiki pages
Use @wiki-onboarding to create onboarding docs
Use @wiki-architect to design wiki structure
Use @wiki-page-writer to create wiki pages
Use @wiki-onboarding to create onboarding docs

Phase 7: Changelog and Release Notes

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

Skills to Invoke

调用技能

  • changelog-automation
    - Changelog generation
  • wiki-changelog
    - Changelog from git
  • changelog-automation
    - 变更日志自动生成
  • wiki-changelog
    - 从Git生成变更日志

Actions

操作步骤

  1. Extract commit history
  2. Categorize changes
  3. Generate changelog
  4. Create release notes
  5. Publish updates
  1. 提取提交历史
  2. 分类变更内容
  3. 生成变更日志
  4. 创建发布说明
  5. 发布更新内容

Copy-Paste Prompts

可复制粘贴的提示词

Use @changelog-automation to generate changelog
Use @wiki-changelog to create release notes
Use @changelog-automation to generate changelog
Use @wiki-changelog to create release notes

Phase 8: Documentation Maintenance

阶段8：文档维护

Skills to Invoke

调用技能

  • doc-coauthoring
    - Collaborative writing
  • reference-builder
    - Reference docs
  • doc-coauthoring
    - 协作写作
  • reference-builder
    - 参考文档构建

Actions

操作步骤

  1. Review documentation
  2. Update outdated content
  3. Fix broken links
  4. Add new features
  5. Gather feedback
  1. 审核文档内容
  2. 更新过时内容
  3. 修复失效链接
  4. 添加新功能说明
  5. 收集用户反馈

Copy-Paste Prompts

可复制粘贴的提示词

Use @doc-coauthoring to collaborate on docs
Use @doc-coauthoring to collaborate on docs

Documentation Types

文档类型

Code-Level

代码级文档

  • JSDoc/TSDoc comments
  • Function documentation
  • Type definitions
  • Example code
  • JSDoc/TSDoc注释
  • 函数文档
  • 类型定义
  • 示例代码

API Documentation

API文档

  • Endpoint reference
  • Request/response schemas
  • Authentication guides
  • SDK documentation
  • 端点参考
  • 请求/响应 schema
  • 认证指南
  • SDK文档

Architecture Documentation

架构文档

  • System overview
  • Component diagrams
  • Data flow diagrams
  • Deployment architecture
  • 系统概述
  • 组件图
  • 数据流图
  • 部署架构

User Documentation

用户文档

  • Getting started guides
  • User manuals
  • Tutorials
  • FAQs
  • 快速入门指南
  • 用户手册
  • 教程
  • 常见问题

Process Documentation

流程文档

  • Runbooks
  • Onboarding guides
  • SOPs
  • Decision records
  • 运行手册
  • 入职指南
  • 标准操作流程（SOPs）
  • 决策记录

Quality Gates

质量检查清单

  • All APIs documented
  • Architecture diagrams current
  • README up to date
  • Code comments helpful
  • Examples working
  • Links valid
  • 所有API已文档化
  • 架构图为最新版本
  • README内容更新至最新
  • 代码注释具有参考价值
  • 示例代码可正常运行
  • 所有链接有效

Related Workflow Bundles

相关工作流套件

  • development
    - Development workflow
  • testing-qa
    - Documentation testing
  • ai-ml
    - AI documentation
  • development
    - 开发工作流
  • testing-qa
    - 文档测试
  • ai-ml
    - AI相关文档