c4-architecture-c4-architecture

C4 Architecture Documentation Workflow

技能概述

为现有代码库自动生成完整的 C4 架构文档，采用自底向上的分析方法，从代码级到系统级逐层合成架构视图。

适用场景

接手现有项目: 快速理解陌生代码库的架构结构和组件关系，减少上手时间

架构文档维护: 代码变更后自动更新架构文档，保持文档与代码同步

团队架构沟通: 为技术评审、架构设计讨论和知识共享提供统一的架构视图

核心功能

代码级分析: 自底向上分析每个代码目录，生成包含函数签名、类定义和依赖关系的完整文档

组件与容器映射: 将代码元素合成为逻辑组件，并映射到实际的部署容器，生成 OpenAPI 规范

系统上下文建模: 创建用户画像、用户旅程和外部系统依赖关系图，面向非技术人员可读

常见问题

C4 架构文档包含哪些层级？

C4 模型包含四个层级：Context（系统上下文）、Container（容器）、Component（组件）和 Code（代码）。本工作流从最底层的代码分析开始，逐层向上合成，最终生成完整的架构文档集。大多数团队使用 Context 和 Container 层级已足够，本工作流生成全部四层供团队按需选择。

生成的文档需要人工修改吗？

工作流提供自动化基础文档，但建议根据实际情况进行人工审阅和调整。特别是 Context 层级的用户画像和业务场景描述，需要结合实际业务背景补充。API 文档和代码依赖关系通常准确度较高，可直接使用。

支持哪些编程语言和项目类型？

本工作流通过分析代码目录结构和文件内容生成文档，理论上支持所有编程语言。对 Python、JavaScript、TypeScript、Java、Go 等主流语言的代码结构识别效果最佳。支持单体应用、微服务、无服务器架构等多种部署模式的文档生成。