⚡

文档生成器 documentation-generator

文档生成器技能是一个自动化工具，专门用于为系统迁移项目创建全面的技术文档。它能够自动生成API接口文档、系统架构图、操作手册、变更记录和迁移指南，支持与Swagger UI、PlantUML、Mermaid等工具集成，帮助开发团队和运维人员快速建立标准化的文档体系，提升系统可维护性和团队协作效率。关键词：文档生成，API文档，架构图，操作手册，系统迁移，自动化文档，技术文档，DevOps文档。

DevOps 0 次安装 0 次浏览 更新于 2/23/2026

name: documentation-generator description: 为迁移系统生成文档，包括API文档、架构文档和操作手册 allowed-tools: [“Bash”, “Read”, “Write”, “Grep”, “Glob”, “Edit”]

文档生成技能

为迁移系统生成全面的文档，包括API文档、架构图和操作手册。

目的

支持以下文档的创建：

  • API文档生成
  • 架构文档
  • 操作手册生成
  • 变更文档
  • 图表生成

功能

1. API文档生成

  • 从OpenAPI规范生成
  • 创建交互式文档
  • 包含示例
  • 支持版本控制

2. 架构文档

  • 创建架构图
  • 记录组件
  • 映射依赖关系
  • 解释设计模式

3. 操作手册生成

  • 创建操作流程
  • 记录故障排除
  • 包含升级路径
  • 生成操作手册

4. 变更文档

  • 记录迁移变更
  • 跟踪前后状态
  • 注明破坏性变更
  • 生成发布说明

5. 迁移指南创建

  • 创建升级指南
  • 记录迁移步骤
  • 包含回滚流程
  • 提供检查清单

6. 图表生成

  • 生成架构图
  • 创建序列图
  • 构建数据流图
  • 生成部署图

工具集成

工具 用途 集成方式
Swagger UI API文档 CLI
AsyncAPI 事件文档 CLI
PlantUML 图表 CLI
Mermaid 图表 Markdown
Backstage 开发者门户 配置
MkDocs 文档站点 CLI

输出模式

{
  "generationId": "string",
  "timestamp": "ISO8601",
  "documentation": {
    "api": {
      "path": "string",
      "format": "string"
    },
    "architecture": {
      "path": "string",
      "diagrams": []
    },
    "runbooks": [],
    "guides": []
  },
  "artifacts": {
    "site": "string",
    "pdfs": [],
    "diagrams": []
  }
}

与迁移流程集成

  • documentation-migration: 主要文档生成
  • 所有迁移流程（变更文档）

相关技能

  • openapi-generator: API规范生成
  • knowledge-extractor: 源材料提取

相关代理

  • documentation-migration-agent: 文档编排
  • operational-readiness-agent: 操作手册创建