C4 Documentation Skill 用于按 C4 模型的四个抽象层级创建架构文档与可视化。使用前要求文档优先:先调用 docs-management skill 获取 C4 模式,通过 MCP 服务器(context7 用于 Structurizr/Mermaid)校验 C4 语法,并以 c4model.com 官方文档为基准。
主要能力与层级:
- 一级系统上下文图:展示系统与用户、外部系统的关系,面向所有人。
- 二级容器图:展示应用、数据存储、微服务及通信方式和技术选型,面向技术人员。
- 三级组件图:展示某容器内部的主要组件、职责与交互,面向架构师和开发者。
- 四级代码图(可选):展示类、接口与实现细节,通常自动生成。
- 补充图:部署图和动态/时序图。
用法:提供 Mermaid 与 PlantUML/Structurizr DSL 语法示例,如 C4Context、C4Container、C4Component、C4Deployment、sequenceDiagram,并给出容器类型(Container、ContainerDb、ContainerQueue、Container_Ext)说明、C4 文档模板(含系统上下文、容器视图、组件视图、部署视图、关键场景)以及 C# C4 元素模型与 IC4DiagramGenerator 接口示例。
适用场景:编写系统架构文档、技术选型说明、复杂领域模型说明、框架或公共 API 文档、关键流程与部署映射。
限制:资料未说明该 Skill 的安装命令、收费或平台要求;四级代码图通常自动生成,是否使用需按需判断。最佳实践建议保持图简洁、统一符号颜色、必要时加图例、架构变更时更新图、尽量自动生成,避免混用抽象层级、遗漏叙述说明或创建无人维护的图。