用途:该技能指导使用 Mermaid 语法创建 C4 模型图,用于软件架构文档。C4 模型按抽象层级可视化架构,遵循 Simon Brown 的 C4 方法论。
主要能力:覆盖四个层级——Level 1 系统上下文(系统与环境关系)、Level 2 容器(技术选型与容器间通信)、Level 3 组件(容器内部拆分)、Level 4 代码(实现细节,可选)。Mermaid 通过 C4Context、C4Container、C4Component 指令支持。
使用时机:系统上下文图用于记录新系统、展示系统边界、识别用户与外部依赖、架构决策记录及文档首页;容器图用于多可部署单元系统、展示技术栈、容器间通信、安全架构(信任边界)与部署文档;组件图用于复杂容器、内部结构说明、新人上手与技术债分析;代码图很少使用,更适合 IDE 可视化,可考虑 UML 类图。
文档要求:必须同时创建当前与未来状态图(ARCHITECTURE.md 和 FUTURE_ARCHITECTURE.md),每图含标题、描述与图例,符号一致,记录元素关系与技术,架构变更时更新版本并保持与代码同步。不得过度细化、混用抽象层级、在容器图省略技术选型或使用含糊关系标签。
最佳实践:命名清晰一致,容器图注明技术/框架,关系标签含协议;每图元素限制 15-20 个,分组相关元素,逻辑排布;文档含标题、说明、图例、假设与约束,并链接相关图。推荐目录结构为 docs/architecture/ 下放 ARCHITECTURE.md、FUTURE_ARCHITECTURE.md 与 decisions/ 中的 ADR。
工具支持:Mermaid Live Editor(https://mermaid.live/)、VS Code 的 Mermaid Preview 与 Markdown Preview Mermaid Support 扩展,GitHub 原生渲染 Markdown 中的 Mermaid。参考:https://c4model.com/、https://mermaid.js.org/syntax/c4.html、https://www.architectis.je/。
限制:资料未提供安装命令、收费或价格信息;代码图适用性有限,建议优先使用 IDE 可视化。