mcpField
C
c4-context

c4-context

github.com/sickn33开发48.7k274 次安装今天更新
代码仓库

关于 c4-context

面向团队的 C4 系统上下文文档 Skill,用于描述系统及其周边关系。它组织人物角色、功能、用户旅程和依赖项,并指导绘制面向利益相关者的 Mermaid 上下文图。

主要功能

  1. 01系统概述模板
  2. 02人物角色与功能文档
  3. 03用户旅程梳理
  4. 04外部系统清单
  5. 05Mermaid 上下文图指导

适用场景

  1. 01编写系统上下文文档
  2. 02梳理用户及其旅程
  3. 03记录外部依赖

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill c4-context

安装后在 Claude Code 中输入/c4-context确认已加载。

详细介绍

C4 上下文级别:系统上下文

适用场景

  • 处理 C4 上下文级别:系统上下文相关任务或工作流
  • 需要 C4 上下文级别:系统上下文方面的指导、最佳实践或检查清单

不适用场景

  • 任务与 C4 上下文级别:系统上下文无关
  • 需要使用此范围之外的其他领域或工具

说明

  • 明确目标、约束和所需输入。
  • 应用相关最佳实践并验证结果。
  • 提供可执行的步骤和验证方法。

系统概述

简短描述

[用一句话描述系统的功能]

详细描述

[详细描述系统的用途、功能以及解决的问题]

用户角色

[用户角色名称]
  • 类型:[人类用户 / 程序化用户 / 外部系统]
  • 描述:[此用户角色的身份及其需求]
  • 目标:[此用户角色希望实现的目标]
  • 使用的主要功能:[列出此用户角色使用的功能]

系统功能

[功能名称]
  • 描述:[此功能的作用]
  • 用户:[使用此功能的用户角色]
  • 用户旅程:[用户旅程图链接]

用户旅程

[功能名称] - [用户角色名称] 旅程
  1. [步骤 1]:[描述]
  2. [步骤 2]:[描述]
  3. [步骤 3]:[描述] ...
[外部系统] 集成旅程
  1. [步骤 1]:[描述]
  2. [步骤 2]:[描述] ...

外部系统和依赖项

[外部系统名称]
  • 类型:[数据库、API、服务、消息队列等]
  • 描述:[此外部系统提供的内容]
  • 集成类型:[API、事件、文件传输等]
  • 用途:[系统依赖此项的原因]

系统上下文图

[展示系统、用户和外部系统的 Mermaid 图]

相关文档

  • 容器文档
  • 组件文档

上下文图模板

根据 C4 模型,系统上下文图将系统显示为中央的一个方框,周围是与之交互的用户和其他系统。重点在于人员(参与者、角色、用户角色)和软件系统,而非技术、协议及其他底层细节。

使用正确的 Mermaid C4 语法:

C4Context
    title System Context Diagram

    Person(user, "User", "Uses the system to accomplish their goals")
    System(system, "System Name", "Provides features X, Y, and Z")
    System_Ext(external1, "External System 1", "Provides service A")
    System_Ext(external2, "External System 2", "Provides service B")
    SystemDb(externalDb, "External Database", "Stores data")

    Rel(user, system, "Uses")
    Rel(system, external1, "Uses", "API")
    Rel(system, external2, "Sends events to")
    Rel(system, externalDb, "Reads from and writes to")

关键原则(来自 c4model.com):

  • 聚焦于人员和软件系统,而非技术
  • 清晰地展示系统边界
  • 包含所有用户(人类用户和程序化用户)
  • 包含系统交互的所有外部系统
  • 确保内容便于利益相关者理解,让非技术受众也能看懂
  • 避免展示技术、协议或底层细节

交互示例

  • “为系统创建 C4 上下文级别文档”
  • “识别所有用户角色,并为关键功能创建用户旅程图”
  • “记录外部系统并创建系统上下文图”
  • “分析系统文档并创建全面的上下文文档”
  • “为所有关键功能(包括程序化用户)绘制用户旅程图”

主要区别

  • 与 C4-Container Agent 的区别:提供高层次的系统视图;Container Agent 侧重于部署架构
  • 与 C4-Component Agent 的区别:侧重于系统上下文;Component Agent 侧重于逻辑组件结构
  • 与 C4-Code Agent 的区别:提供便于利益相关者理解的概述;Code Agent 提供技术代码细节

输出示例

创建上下文文档时,请提供:

  • 清晰的系统说明(简短版和详细版)
  • 全面的用户角色文档(面向人类和程序)
  • 完整的功能列表及说明
  • 所有关键功能的详细用户旅程图
  • 完整的外部系统和依赖项文档
  • 展示系统、用户和外部系统的 Mermaid 上下文图
  • 容器和组件文档的链接
  • 利益相关者易于理解的文档,非技术人员也能看懂
  • 一致的文档格式

限制

  • 仅当任务明确符合上述范围时,才使用此技能。
  • 请勿将输出视为环境特定验证、测试或专家审查的替代品。
  • 如果缺少所需输入、权限、安全边界或成功标准,请停止并请求澄清。

评论

支持 Markdown