Appearance
使用 AI 自动化生成 C4 模型架构文档
解决遗留代码缺乏文档的痛点:通过自底向上的分析流,驱动 AI 自动扫描代码库并生成符合 C4 标准(Context, Container, Component, Code)的完整架构文档集。
为什么需要这个技能
在维护大型项目时,最痛苦的往往是面对一个没有文档的既有代码库。手动绘制架构图不仅耗时,而且随着代码更迭,文档会迅速失效。
C4 模型提供了一种分层抽象的视角,但手动维护四层图表(上下文、容器、组件、代码)工作量极大。本技能通过一套标准化的工作流,让 AI 扮演四个专门的 C4 Agent,从最细粒度的代码目录开始分析,逐步向上合成高层架构,确保文档与实际代码逻辑严格一致。
适用场景
- 接手遗留项目:快速理清陌生代码库的整体结构和调用关系。
- 技术审计与交付:需要为现有系统快速生成一套完整的、可交付的架构设计文档。
- 架构同步:在进行大规模重构前,通过 AI 捕捉当前的实际物理架构。
- 跨团队沟通:为非技术利益相关者生成高层 Context 图,为开发人员生成详细的 Component 图。
核心工作流
该技能采用**自底向上(Bottom-Up)**的合成策略,分为四个阶段:
- 代码级分析 (Code Level):从最深层子目录开始,分析函数签名、类定义及依赖,生成
c4-code-*.md基础文档。 - 组件级合成 (Component Level):将相关的代码级文档聚合成逻辑组件,定义接口协议(REST/gRPC 等),并绘制 Mermaid 组件图。
- 容器级映射 (Container Level):结合 Dockerfile、K8s 配置等部署定义,将组件映射到物理容器(如 Web App、Database),并自动生成 OpenAPI 3.1 接口规范。
- 上下文定义 (Context Level):分析 README 和测试用例,定义用户角色(Personas)与用户旅程(User Journeys),生成最高层的系统上下文图。
所有输出将统一存放在仓库根目录的 C4-Documentation/ 文件夹中,形成一套可追溯的文档链。
下载和安装
下载 c4-architecture-c4-architecture 中文版 Skill ZIP
解压后将目录放入你的 AI 工具 skills 文件夹,重启工具后即可使用。具体路径参考内附的 USAGE.zh.md。
你可能还需要
暂无推荐