【研发类-架构设计Skills】c4-architecture-c4-architecture 技能

使用自下而上的分析方法,为现有存储库/代码库生成全面的C4架构文档。技能概述c4-architecture-c4-architecture 技能实现了完整的C4架构文档流程,遵循C4模型(上下文、容器、组件、代码)。它使用自下而上的方法,从最深的代码目录开始向上工作,确保在合成为更高级别的抽象之前记录每个代码元素。该工作流协调四个专门的C4代理(代码、组件、容器、上下文),创建一个完整的架构文档集,服务于技术和非技术利益相关者。下载地址:https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/c4-architecture-c4-architecture触发条件使用此技能的情况:处理C4架构文档工作流任务或工作流需要C4架构文档工作流的指导、最佳实践或检查清单工作流程概览此工作流程遵循官方C4模型创建全面的C4架构文档:1. 代码级别自下而上分析每个子目录,创建代码级文档2. 组件级别将代码文档合成为容器内的逻辑组件3. 容器级别将组件映射到部署容器,包含API文档(显示高级技术选择)4. 上下文级别创建高级系统上下文,包含角色和用户旅程(关注人员和软件系统,而非技术)输出结构C4-Documentation/├── c4-code-*.md # 代码级文档每个目录一个├── c4-component-*.md # 组件级文档每个组件一个├── c4-component.md # 主组件索引├── c4-container.md # 容器级文档├── c4-context.md # 上下文级文档└── apis/ # API规范├── [container]-api.yaml # 每个容器的OpenAPI规范└── ...成功标准✅ 每个子目录都有对应的c4-code-*.md文件✅ 所有代码级文档包含完整的函数签名✅ 组件逻辑分组,边界清晰✅ 所有组件都有接口文档✅ 创建了主组件索引和关系图✅ 容器映射到实际部署单元✅ 所有容器API都有OpenAPI/Swagger规范✅ 容器图显示部署架构✅ 系统上下文包含所有角色(人员和程序化)✅ 为所有关键功能记录了用户旅程✅ 识别了所有外部系统和依赖项✅ 上下文图显示系统、用户和外部系统协调说明自下而上处理: 从最深到最浅处理目录增量合成: 每个级别构建在前一级别的文档上完整覆盖: 在合成之前每个目录必须有代码级文档链接一致性: 所有文档文件适当地相互链接API文档: 容器API必须有OpenAPI/Swagger规范利益相关者友好: 上下文文档应能被非技术利益相关者理解Mermaid图: 所有图使用正确的C4 Mermaid符号使用限制仅当任务明显符合上述描述的范围时才使用此技能不要将输出作为环境特定验证、测试或专家审查的替代品如果缺少所需的输入、权限、安全边界或成功标准,请停止并要求澄清