【研发类-开发方法论Skills】c4-container 技能

专家级C4容器级文档专家。技能概述c4-container 技能是一个专门用于创建C4容器级文档的技能。它专注于系统部署架构将组件映射到部署单元并记录容器间的通信协议和依赖关系。该技能能够生成详细的容器图和OpenAPI/Swagger规范帮助团队理解系统的部署架构。下载地址agentic-awesome-skills/skills/c4-container at main · sickn33/agentic-awesome-skills · GitHub主要功能容器文档记录容器的名称、描述、类型、技术和部署方式接口文档记录API接口、协议和规范依赖关系映射识别容器间的依赖关系和外部系统基础设施文档记录部署配置、扩展策略和资源需求容器图生成生成Mermaid C4Container图表展示部署架构触发条件在以下情况下应该调用此技能处理C4容器级系统部署任务或工作流时需要C4容器级系统部署的指导、最佳实践或检查清单时需要将组件合成为容器并记录部署定义时需要创建容器级文档和API规范时不适用场景不适用情况任务与C4容器级系统部署无关时需要此范围之外的不同域或工具时处理过程1. 明确目标明确目标、约束条件和所需的输入确保理解部署架构需求。2. 分析组件分析现有组件确定如何将它们映射到部署单元容器。3. 应用最佳实践应用相关的最佳实践并验证结果确保容器架构的合理性。4. 生成文档提供可操作的步骤和验证生成结构化的C4容器级文档。容器文档结构容器信息名称容器名称描述容器用途和部署的简短描述类型Web应用、API、数据库、消息队列等技术主要技术栈Node.js、Python、PostgreSQL、Redis等部署Docker、Kubernetes、云服务等接口信息协议REST/GraphQL/gRPC/Events等描述接口提供的功能规范OpenAPI/Swagger/API规范文件链接关键原则展示高级技术选择这是技术细节所属的层级展示职责分布展示职责如何在容器间分布包含容器类型应用、数据库、消息队列、文件系统等展示通信协议容器间的通信协议包含外部系统容器交互的外部系统示例交互常见任务根据部署定义将所有组件合成为容器将API组件映射到容器并将它们的API记录为OpenAPI规范为微服务架构创建容器级文档将容器接口记录为Swagger/OpenAPI规范分析Kubernetes清单并创建容器文档关键区别vs C4-Component agent将组件映射到部署单元Component agent专注于逻辑分组vs C4-Context agent提供容器级细节Context agent创建高级系统图vs C4-Code agent专注于部署架构Code agent记录单个代码元素输入要求使用此技能时用户需要提供系统架构和组件信息部署定义和配置技术栈和基础设施信息API和接口需求输出说明技能将提供清晰的容器边界和部署理由描述性容器名称和部署特征完整的API文档和OpenAPI/Swagger规范指向所有包含组件的链接展示部署架构的Mermaid容器图指向部署配置的链接Dockerfiles、K8s清单等基础设施需求和扩展考虑最佳实践明确边界清晰定义容器边界和部署理由记录技术选择详细记录每个容器的技术栈规范接口使用OpenAPI/Swagger规范记录API展示依赖完整记录容器间和外部依赖考虑扩展记录扩展策略和资源需求局限性仅当任务明确符合上述范围时使用此技能不要将输出作为环境特定验证、测试或专家审查的替代品如果缺少所需的输入、权限、安全边界或成功标准请停止并寻求澄清