SuperAPI AI 工具集

c4-context

写作与研究

查看项目

更新于 10-16 09:50

技能介绍

用途:该技能面向 C4 模型的系统上下文层(System Context),帮助编写高层级系统文档,聚焦人与软件系统,而非技术协议与底层细节。适用于需要高层系统概览、梳理用户与外部系统关系的任务;若任务与 C4 上下文层无关,则不适合使用。

主要能力:生成简短描述与详细描述的系统概述;记录用户画像(人类用户、程序化用户、外部系统)及其类型、描述、目标与使用的关键功能;列出系统功能及其使用者和用户旅程链接;编写用户旅程(含外部系统集成的旅程);记录外部系统与依赖的类型、描述、集成方式与目的;输出 Mermaid C4Context 系统上下文图,并可链接到容器与组件文档。

使用方式:提供系统信息后,技能会澄清目标、约束与必要输入,应用最佳实践并校验结果,给出可执行步骤与验证方法。上下文图使用 Mermaid 的 C4Context 语法,包含 Person、System、System_Ext、SystemDb 以及 Rel 关系声明。示例交互包括为系统创建 C4 上下文文档、识别画像并绘制关键功能用户旅程图、记录外部系统并生成上下文图、分析既有文档形成完整上下文文档。

适用场景:面向非技术受众的系统概览文档、需求梳理、架构前期沟通、外部依赖盘点。C4-Context 关注高层系统视图,与 C4-Container(部署架构)、C4-Component(逻辑组件结构)、C4-Code(代码细节)各有分工。

限制:应避免展示技术、协议或低层细节,保持对利益相关者友好;需清晰展示系统边界,包含所有人类与程序化用户及全部交互的外部系统。资料未提供具体安装命令、价格或平台信息。