name: 架构文档 description: 使用模板和图集成生成架构文档，用于创建C4图、视图文档和技术概览。 allowed-tools: 读取、写入、全局、搜索、技能、任务

架构文档

何时使用此技能

使用此技能当您需要：

为系统生成架构文档
创建C4图（上下文、容器、组件）
为不同利益相关者视图记录架构
生成技术概览或执行摘要

关键词： 文档、c4、容器、上下文、组件、视图、架构描述、技术概览、执行摘要

文档类型

类型	受众	内容
上下文	所有利益相关者	系统边界、外部交互
容器	技术领导	服务、数据库、主要组件
组件	开发者	容器的内部结构
部署	运维人员	基础设施、环境
数据	数据架构师	数据流、存储、模式
执行摘要	领导层	商业价值、关键决策

文档生成工作流

1. 分析代码库

在生成文档之前：

识别范围（单个服务、多个服务、整个系统）
查找现有文档以整合
定位关键架构文件（配置、部署规范）

2. 选择文档类型

根据以下选择：

受众：谁将阅读此文档？
目的：决策支持、入职培训、合规？
范围：组件、服务或系统级别？

3. 生成文档

每种文档类型都有标准结构：

上下文文档

# 系统上下文：[系统名称]

## 概述
[1-2段描述]

## 上下文图
[C4上下文图 - 通过可视化插件]

## 外部系统
| 系统 | 描述 | 集成 |
| --- | --- | --- |
| ... | ... | ... |

## 用户/执行者
| 执行者 | 描述 | 交互 |
| --- | --- | --- |
| ... | ... | ... |

容器文档

# 容器架构：[系统名称]

## 概述
[架构摘要]

## 容器图
[C4容器图 - 通过可视化插件]

## 容器
### [容器名称]
- **技术**：[技术栈]
- **目的**：[描述]
- **职责**：[列表]
- **依赖**：[列表]

组件文档

# 组件架构：[容器名称]

## 概述
[组件结构摘要]

## 组件图
[C4组件图 - 通过可视化插件]

## 组件
### [组件名称]
- **类型**：[服务/仓库/控制器等]
- **职责**：[列表]
- **接口**：[公共API]

4. 集成图表

如果可视化插件可用：

调用 visualization:diagram-generator 代理
请求适当的C4图类型
将生成的Mermaid/PlantUML代码嵌入文档

备用方案：如果可视化插件不可用，创建基于文本的架构描述，并注明图表可以通过可视化插件添加。

模板结构

所有架构文档应包括：

头部：标题、版本、日期、作者
概述：1-2段摘要
图表：视觉表示
细节：组件的结构化信息
决策：链接到相关ADR
参考文献：链接到相关文档

完整性检查清单

在最终化文档之前，验证：

[ ] 范围明确定义
[ ] 所有主要组件已识别
[ ] 外部依赖已记录
[ ] 关键决策链接到ADR
[ ] 图表匹配文本描述
[ ] 使用适合受众的语言
[ ] 包含版本和日期

仓库位置

生成的文档应放置在：

/architecture/
  /viewpoints/
    context.md
    containers.md
    components/
      [container-name].md
    executive-summary.md

与其他技能的集成

adr-management：在文档中链接到相关ADR
togaf-guidance：与当前ADM阶段对齐
zachman-analysis：确保适当的视图覆盖

版本历史

v1.0.0 (2025-12-05)：初始发布
- C4图的文档生成工作流
- 六种文档类型（上下文、容器、组件、部署、数据、执行摘要）
- 可视化插件集成
- 完整性检查清单

最后更新

日期： 2025-12-05 模型： claude-opus-4-5-20251101