利用 AI 快速绘制与编写 C4 容器级架构文档

解决架构文档维护难的痛点：引导 AI 将复杂的系统逻辑转化为 C4 容器级视图，自动生成 Mermaid 架构图、技术栈描述及标准 API 规范，实现架构设计与部署文档的同步。

为什么需要这个技能

在软件开发中，简单的系统上下文图（Context）太笼统，而代码级的类图又太琐碎。C4 模型中的“容器（Container）”层级正好填补了这一空白——它描述的是可独立部署的单元（如 Web 应用、数据库、消息队列）。

手动绘制架构图和编写接口文档极其耗时，且容易在代码更新后失效。通过此技能，AI 可以直接分析 Kubernetes 配置文件或组件定义，快速输出标准化的 C4 容器图和 OpenAPI 规格书，确保技术方案在团队间高效传递。

适用场景

• 微服务拆分：需要将逻辑组件映射到具体的容器部署单元时。
• 技术选型评审：向团队展示各容器采用的技术栈（如 Node.js, PostgreSQL）及其通信协议。
• 自动化文档生成：将 K8s Manifest 或 Dockerfile 分析为高层架构文档。
• 接口对齐：为每个容器生成对应的 Swagger/OpenAPI 接口定义。

核心工作流

1. 定义边界与输入：向 AI 提供系统目标、约束条件或现有的组件清单（Component list）。
2. 映射部署单元：AI 将逻辑组件归类到具体的容器中，并标注名称、类型（如 API、DB）和技术栈。
3. 绘制容器图：利用 Mermaid C4Container 语法生成可视化拓扑图，明确容器间的交互协议（如 HTTPS, gRPC）。
4. 细化接口与基础设施：为每个容器生成 OpenAPI 规范，并补充部署配置（K8s 资源需求、扩缩容策略）等基础设施信息。

下载和安装

下载 c4-container 中文版 Skill ZIP

解压后将目录放入你的 AI 工具 skills 文件夹，重启工具后即可使用。具体路径参考内附的 USAGE.zh.md。

你可能还需要

暂无推荐