C4 组件层
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @org-02qudk26/c4-component。
技能介绍
要解决什么问题
系统已经拆到容器之后,工程师仍常面对「这一容器里到底有哪些逻辑块、谁调谁、对外暴露什么」的空白。把仓库里散落的 c4-code-*.md 当作事实来源时,缺少统一的组件边界、接口清单和单容器内的关系图,评审和 onboarding 只能反复翻代码。
技能如何工作
本技能面向 C4 模型的组件层:在单个容器内把多个代码级元素综合为逻辑组件,而不是替你做部署映射(容器层)或画全系统上下文(上下文层)。
典型流程可以概括为:
- 对齐输入:明确组件名、目标、约束与已有
c4-code-*.md等材料。 - 划定边界:给出有理由的组件划分,并为每个组件写名称、用途、类型与技术栈。
- 写清契约:为每个接口记录协议(REST / GraphQL / gRPC / Events 等)、描述与
operationName(params): ReturnType形式的操作说明。 - 梳理依赖:区分「使用的组件」与「外部系统」,说明如何被调用或集成。
- 出图与索引:用符合 Mermaid C4Component 语法的组件图展示接口与交互,并维护主组件索引;更细的示例见
resources/implementation-playbook.md。
与相关角色的分工:C4-Code 只记录单个代码元素;本技能做文件到组件的综合;C4-Container 把组件映射到部署单元;C4-Context 负责更高层的系统图。
适用边界
任务与指定组件名的 C4 组件层无关时不必启用。输出侧应保持一致:每个组件有特性列表、完整接口文档、到相关 c4-code-*.md 的链接,以及展示关系的组件图。
使用场景
- 容器已画定,需把该容器内多个 `c4-code-*.md` 综合成带边界的逻辑组件清单
- 认证与授权相关代码散落多模块,要划定组件边界并写清各自职责
- API 层缺少组件级说明,需补全协议、操作与对外接口文档
- 数据库访问与仓储类代码需按组件分组,并用 Mermaid 画出容器内调用关系
适合人员
- 负责单体或微服务容器内拆分的架构师,需要可评审的组件图与接口索引
- 维护 C4 文档的平台工程师,要把 Code 层产物升级到一致的 Component 层输出
- 新接手某服务的后端 Tech Lead,需在 onboarding 前整理组件依赖与外部系统清单
- 做架构评审的 Staff 工程师,要求每个组件有特性、接口与到 `c4-code-*.md` 的追溯链接