C4 Architecture 说明文档

# C4 架构技能 使用 Mermaid 语法通过 C4 模型生成软件架构文档。 ## 目的 此技能可帮助您使用 C4（上下文、容器、组件、代码）模型创建专业的架构文档。它生成的 Mermaid 图表可以可视化不同抽象级别的系统架构，从而便于向不同的受众传达设计决策。 ## 使用场景 在以下情况使用此技能： - 为文档创建架构图 - 可视化软件结构和关系 - 为不同受众（高管、开发人员、DevOps）记录系统架构 - 生成 C4 上下文、容器、组件或部署图 - 创建显示请求流程的动态图 - 记录微服务或事件驱动架构 **触发短语**：“架构图”、“C4 图”、“系统上下文”、“容器图”、“组件图”、“部署图”、“记录架构”、“可视化架构” ## 工作原理 该技能遵循系统化的工作流： 1. **理解范围** - 根据您的受众确定所需的 C4 级别 2. **分析代码库** - 探索系统以识别组件、容器和关系 3. **生成图表** - 在适当的抽象级别创建 Mermaid C4 图表 4. **记录** - 将图表写入带有解释性上下文的 Markdown 文件中 ### C4 图表级别 | 级别 | 图表类型 | 受众 | 展示内容 | 创建时机 | |-------|-------------|----------|-------|----------------| | 1 | **C4Context** | 所有人 | 系统 + 外部参与者 | 始终（必需） | | 2 | **C4Container** | 技术人员 | 应用、数据库、服务 | 始终（必需） | | 3 | **C4Component** | 开发人员 | 内部组件 | 仅在有价值时 | | 4 | **C4Deployment** | DevOps | 基础设施节点 | 针对生产系统 | | - | **C4Dynamic** | 技术人员 | 请求流程（编号） | 针对复杂工作流 | **关键洞察**：“上下文 + 容器图对于大多数软件开发团队来说已经足够。”仅在确实能增加价值时才创建组件/代码图。 ## 关键特性 - **多抽象级别** - 生成上下文、容器、组件、部署和动态图 - **适合受众的细节** - 自动为您的受众选择合适的细节级别 - **内置最佳实践** - 遵循 C4 模型规范并避免反模式 - **微服务支持**