SuperAPI AI 工具集

c4-container

部署与运维

查看项目

更新于 10-15 22:33

技能介绍

用途:该技能面向 C4 模型中的容器级(Container Level)文档编写,适用于系统部署相关任务与工作流,提供指导、最佳实践与检查清单。不适用于与容器级系统部署无关的任务,或超出该范围的领域与工具。

主要能力:梳理目标、约束与所需输入;应用相关最佳实践并验证结果;给出可执行步骤与验证方式。文档结构包括容器名称、描述、类型(Web 应用、API、数据库、消息队列等)、技术栈、部署方式(Docker、Kubernetes、云服务等)、用途、所含组件(链接 c4-component-name.md)、接口(协议、说明、规范链接、端点)、依赖(使用的容器与外部系统)、基础设施(部署配置链接、扩缩容策略、资源需求)。

使用方式:按模板逐项填写容器信息;为每个容器 API 编写 OpenAPI/Swagger 规范;使用 Mermaid C4Container 语法绘制容器图,展示高层技术选型、职责分布、容器类型、通信协议与外部系统。关键原则参考 c4model.com。

适用场景:将组件按部署定义综合为容器;把 API 组件映射到容器并记录为 OpenAPI 规范;为微服务架构创建容器级文档;分析 Kubernetes 清单并生成容器文档。

与其他 C4 技能区别:相比组件级关注逻辑分组,本技能将组件映射到部署单元;相比上下文级提供更细的容器细节;相比代码级聚焦部署架构而非单个代码元素。

限制:仅在任务明确匹配上述范围时使用;输出不能替代针对具体环境的验证、测试或专家评审;若缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。