Visual Paradigm AI 聊天机器人使得根据应用程序、其用户及其交互的外部系统的自然语言描述来创建 C4 系统上下文图成为可能。然而，AI 生成的图表在生成后保持可编辑和可维护时最为有用。

本指南演示了使用 C4-PlantUML 生成外卖平台上下文图的全流程。您将学习如何从 AI 生成的图表转换为可编辑的 PlantUML 代码，在 VPasCode 中优化模型，并在 Visual Paradigm Online 中继续以图形方式编辑。该方法结合了 AI 辅助建模的速度、图表即代码的灵活性以及图形图表编辑器的便捷性。

Visual Paradigm 提供了一套实用的工作流程，将自然语言架构描述转换为可编辑的 C4 上下文图：

1. 在 Visual Paradigm AI 聊天机器人中描述该系统。

   

2. 生成并审查 C4 系统上下文图。

3. 在 VPasCode 中以 C4-PlantUML 格式打开结果。

   

4. 通过编辑 PlantUML 代码修改图表。

   

5. 可选地将结果发送至 Visual Paradigm Online。

   

6. 使用拖放式图表编辑器以图形方式修改图表。

这为您提供两种编辑路径：

• 基于代码的编辑：VPasCode 和 C4-PlantUML

• 基于图形用户界面的编辑：Visual Paradigm Online 图表编辑器

Visual Paradigm 的 AI 聊天机器人支持 C4 系统上下文图、容器图、组件图和部署图。它还可以通过自然语言命令（如添加、删除、重命名或重新连接元素）来优化生成的图表。

1. 理解 C4 上下文图

C4 上下文图是软件系统的最高层级视图。它展示：

• 目标系统

• 人类用户和组织参与者

• 外部软件系统

• 这些元素之间的重要关系

• 每种关系如何运作的简要描述

它通常不显示内部服务、数据库、类、API 或基础设施细节。这些内容属于更低层级的 C4 图表。

例如，一个在线外卖平台的上下文图可能包含：

• 顾客

• 餐厅经理

• 配送员

• 支付提供商

• 地图与地理定位服务

• 通知服务

• 食品配送平台

中心系统应作为视觉焦点。外部人员和系统应围绕其布置。

2. 准备一个优质的 AI 提示词

生成图表的质量很大程度上取决于提供给聊天机器人的架构描述。

一个有用的提示词应包含以下内容：

• 系统名称

• 系统的目的

• 使用该系统的人员

• 与其通信的外部系统

• 它们之间的关系

• 所需的 C4 图表层级

• 所需的输出格式

• 不应包含的内容

示例提示词

为在线食品配送平台创建一个 C4 系统上下文图。

感兴趣系统：
食品配送平台 — 允许客户浏览餐厅、下单、支付和追踪配送。

人员：
1. 客户 — 浏览餐厅、下单、支付并追踪配送。
2. 餐厅经理 — 管理菜单、接受订单并更新订单状态。
3. 配送员 — 接受配送任务并更新配送进度。
4. 运营管理员 — 监控平台活动并处理支持问题。

外部系统：
1. 支付提供商 — 授权并收取客户付款。
2. 地图与地理定位服务 — 提供地址、路线和配送位置。
3. 通知服务 — 发送电子邮件、短信和推送通知。

关系：
- 客户使用食品配送平台浏览餐厅、下单、支付和追踪配送。
- 餐厅经理使用食品配送平台管理菜单和处理订单。
- 配送员使用食品配送平台接收配送任务并更新配送状态。
- 运营管理员使用食品配送平台监控运营并解决问题。
- 食品配送平台使用支付提供商进行授权和收款。
- 食品配送平台使用地图与地理定位服务计算路线和追踪位置。
- 食品配送平台使用通知服务发送通知。

生成一个清晰的 C4 系统上下文图。不要显示内部容器、组件、数据库、类或部署基础设施。使用简洁的关系标签。

明确指示排除内部细节非常重要。如果没有此指示，AI 生成器可能会生成混合了上下文层级和容器层级信息的图表。

3. 在 Visual Paradigm AI 聊天机器人中生成图表

打开 Visual Paradigm AI 聊天机器人，开始新的对话或图表生成会话。

根据界面和订阅版本的不同，聊天机器人可能会提供图表类型选择器。请选择：

• C4 模型

• 系统上下文图

然后输入提示词。

Visual Paradigm 的一般聊天机器人工作流程如下：

1. 描述图表。

2. 让 AI 生成初始模型。

3. 审查结果。

4. 使用自然语言命令对其进行优化。

5. 导出或在另一个 Visual Paradigm 工具中继续编辑。

审查第一个结果

检查图表是否包含：

• 恰好一个中心系统

• 所有必要的人员

• 所有相关的外部系统

• 正确的关系方向

• 简洁的关系描述

• 无不必要的内部服务或数据库

• 命名一致

• 布局清晰可读

生成的图表只是一个起点，不能替代架构审查。

4. 通过对话完善图表

聊天机器人可以使用普通语言修改图表。

添加一个元素

添加一名客户服务代理，该代理使用食品配送平台调查客户问题并处理退款。

添加一个外部系统

添加一个由食品配送平台使用的外部欺诈检测服务，用于评估可疑支付。

重命名一个元素

将“通知服务”重命名为“消息与通知服务”。

更改一个关系

将配送员与食品配送平台之间的关系更改为：
“接收配送任务并提交配送状态更新。”

移除一个元素

从图表中移除运营管理员。

改进布局

重新排列图表，使人员位于顶部，外部系统位于底部，食品配送平台保持居中。

简化图表

将其简化为严格的 C4 系统上下文图。移除实现细节、数据库、API、微服务和内部组件。

请求一致性审查

审查图表是否存在缺失的关系、模糊的标签、重复的系统以及不属于 C4 上下文图的元素。

AI 聊天机器人文档描述了这种迭代方法，包括添加支付网关、重命名元素、更改关系和重构图表的命令。

第一部分：在 VPasCode 中打开图表以进行代码编辑

5. 使用“在 VPasCode 中打开”或“在 VPasCode 中编辑”

生成并完善图表后，请使用标有类似以下内容的操作：

• 在 VPasCode 中打开

• 在 VPasCode 中编辑

• 打开代码

• 生成代码以供编辑

确切的按钮标签可能因当前界面而异。

这将把图表的代码传输到 VPasCode，您可以在其中将图表作为文本进行编辑，同时查看实时渲染的预览。Visual Paradigm 将 VPasCode 描述为一种基于浏览器的“图表即代码”编辑器，支持 PlantUML、C4 模型、Mermaid、Graphviz 以及其他语法格式。

生成的代码应使用 C4-PlantUML，通常包含以下内容：

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
...
@enduml

生成的脚本可能会使用不同的包含 URL 或内部支持的库版本。除非您有特定理由需要更改，否则请保留 VPasCode 生成的包含语句。

6. 理解 C4-PlantUML 结构

典型的 C4-PlantUML 上下文图表包含以下部分：

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml

LAYOUT_LEFT_RIGHT()

Person(customer, "Customer", "Places food orders and tracks deliveries.")
System(platform, "Food Delivery Platform", "Allows customers to order food and track delivery.")
System_Ext(payment, "Payment Provider", "Authorizes and captures payments.")

Rel(customer, platform, "Places orders and tracks deliveries")
Rel(platform, payment, "Authorizes and captures payments")

@enduml

主要元素类型

第一个参数是内部标识符，第二个是显示名称，第三个是描述。

7. 在 VPasCode 中编辑图表

VPasCode 通常显示：

• 编辑器窗格中的源代码

• 预览窗格中渲染的图表

• 用于导出、共享、复制或在另一个 Visual Paradigm 产品中打开结果的选项

VPasCode 提供实时渲染并支持直接代码编辑。当代码粘贴到编辑器中时，它还能检测支持的图表格式。

示例：改进的 C4-PlantUML 代码

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml

title 外卖配送平台 — 系统上下文

LAYOUT_LEFT_RIGHT()
SHOW_LEGEND()

Person(customer, "客户",
  "浏览餐厅、下单、支付并跟踪配送。")

Person(restaurantManager, "餐厅经理",
  "管理菜单、接收订单并更新订单状态。")

Person(deliveryDriver, "配送员",
  "接收配送任务并更新配送进度。")

Person(operationsAdmin, "运营管理员",
  "监控平台运营并处理支持问题。")

System(platform, "外卖配送平台",
  "支持食品订购、支付、餐厅管理和配送跟踪。")

System_Ext(paymentProvider, "支付提供商",
  "授权并收取客户付款。")

System_Ext(mapService, "地图与地理定位服务",
  "提供地址、路线和位置数据。")

System_Ext(notificationService, "通知服务",
  "发送电子邮件、短信和推送通知。")

Rel(customer, platform,
  "浏览餐厅、下单、支付并跟踪配送")

Rel(restaurantManager, platform,
  "管理菜单并处理餐厅订单")

Rel(deliveryDriver, platform,
  "接收配送任务并提交配送状态")

Rel(operationsAdmin, platform,
  "监控运营并处理支持问题")

Rel(platform, paymentProvider,
  "授权并收取付款")

Rel(platform, mapService,
  "计算路线并跟踪配送位置")

Rel(platform, notificationService,
  "发送订单、支付和配送通知")

@enduml

8. 进行通用的代码级别更改

更改系统名称

System(platform, "餐食配送平台",
  "协调食品订购与配送。")

添加新人员

Person(customerSupport, "客户支持专员",
  "调查客户问题并处理退款。")

Rel(customerSupport, platform,
  "调查问题并处理退款")

添加新外部系统

System_Ext(fraudService, "欺诈检测服务",
  "评估可疑支付活动。")

Rel(platform, fraudService,
  "检查支付交易是否存在欺诈风险")

更改关系方向

Rel(paymentProvider, platform,
  "返回支付授权和结算结果")

使用关系方向来表示主要依赖或交互。如果方向在架构上不重要，请选择一致的约定并在整个图表中应用它。

更改布局

C4-PlantUML 支持布局提示，例如：

LAYOUT_LEFT_RIGHT()

或：

LAYOUT_TOP_DOWN()

您还可以通过方向提示来影响布局：

Lay_R(客户，平台)
Lay_D(平台，支付提供商)

谨慎使用布局提示。过多的手动约束会使图表更难维护。

9. 使用 VPasCode AI 辅助功能

部分 VPasCode 版本提供 AI 辅助的图表修改和代码错误修复功能。该工具可接受如下指令：

在平台与支付提供商之间添加外部欺诈检测服务。

或：

修复 PlantUML 语法错误，并保留当前图表结构。

VPasCode 还被记录为支持 AI 驱动的图表修改、错误诊断和翻译功能，尽管可用性可能取决于版本或订阅。

10. 验证 PlantUML 图表

在将图表发送至 Visual Paradigm Online 之前，请验证其语法和架构。

语法检查清单

• 脚本以以下语句开头：@startuml.

• 脚本以以下语句结尾：@enduml.

• 已包含 C4-PlantUML 库。

• 每个关系都引用已存在的标识符。

• 标识符不包含可能导致语法错误的空格或标点符号。

• 引号已正确配对。

• 描述未过长。

• 预览渲染无错误。

C4 建模检查清单

• 存在一个明确识别的目标系统。

• 用户被建模为人员，而非软件系统。

• 外部应用程序被建模为外部系统。

• 上下文图中不包含内部容器。

• 关系描述了有意义的交互。

• 该图表无需阅读源代码即可理解。

• 术语与项目的架构文档一致。

系统上下文图中不理想的元素示例

Container(api, "订单 API", "Java", "处理订单")
ContainerDb(database, "订单数据库", "PostgreSQL", "存储订单")

这些是容器级元素。它们应属于 C4 容器图，而非常规的系统上下文图。

第 2 部分：将图表发送至 Visual Paradigm Online

11. 使用“在 VP Online 中编辑”或“在 VP Online 图表中编辑”

代码版本正确后，选择标签类似的操作：

• 在 VP Online 中编辑

• 在 VP Online 图表中编辑

• 在在线环境中打开

• 导出至 VP Online

具体标签可能因界面版本而异。

Visual Paradigm 的生态系统旨在将生成的图表从 AI 聊天机器人移至 VPasCode 进行代码级优化，然后再移至 Visual Paradigm Online 进行传统图表编辑。

当您需要进行以下操作时，在线图表编辑器非常有用：

• 手动移动形状

• 调整元素大小

• 调整连接线

• 更改颜色和字体

• 添加注释或标注

• 添加标题或图例

• 应用演示格式

• 精确对齐图表元素

• 准备图表以供共享或导出

12. 使用 Visual Paradigm Online 图形用户界面修改图表

一旦图表在 Visual Paradigm Online 中打开：

移动元素

将人员和外部系统拖放到围绕中心系统的清晰布局中。

常见布局如下：

• 人员位于左侧或上方

• 主系统位于中心

• 外部系统位于右侧或下方

编辑文本

双击元素或选择其规范面板以修改：

• 名称

• 描述

• 构造型

• 关系标签

保持名称简短，描述具有信息量。

编辑关系

选择连接器以：

• 更改其方向

• 编辑关系标签

• 将其重新连接到另一个元素

• 调整其路由

• 更改线条样式或外观

添加元素

使用图表调色板添加：

• 人员

• 外部人员

• 系统

• 外部系统

• 关系

• 注意

• 边界

仅添加属于上下文级别的元素。

应用格式

您可以通过调整以下内容来提高可读性：

• 字体大小

• 填充颜色

• 边框颜色

• 线条粗细

• 形状大小

• 对齐方式

• 间距

• 连接线布局

避免仅使用颜色来传达含义，同时使用清晰的标签。

13. 推荐的展示布局

一个清晰的上下文图可能会采用以下布局：

对于较大的图表：

• 将主系统置于中心位置。

• 将人员分组放在一侧。

• 将外部软件系统分组放在另一侧。

• 避免关系线交叉。

• 尽可能保持关系标签水平。

• 使用简短标签而非段落。

• 在中央系统周围留出足够的空白区域。

第 3 部分：在代码编辑与图形界面编辑之间选择

VPasCode 通过 PlantUML 支持 C4 模型并提供实时预览，而 Visual Paradigm Online 提供传统的可视化图表编辑工作流。

第 4 部分：推荐的端到端工作流

快速工作流

1. 打开 Visual Paradigm AI 聊天机器人。

2. 选择 C4 系统上下文图。

3. 描述系统、用户和外部系统。

4. 生成图表。

5. 要求聊天机器人移除内部实现细节。

6. 审查名称、关系和范围。

7. 选择在 VPasCode 中打开.

8. 编辑 C4-PlantUML 源代码。

9. 渲染并验证结果。

10. 选择在 VP Online 中编辑.

11. 使用图形用户界面优化布局和外观。

12. 导出或分享最终图表。

建议的职责分工

使用AI 聊天机器人用于：

• 创建初稿

• 探索架构替代方案

• 添加或删除参与者

• 重述关系描述

• 审查图表以查找遗漏项

使用VPasCode用于：

• 重命名多个元素

• 复用图表代码

• 应用一致的语法

• 在版本控制中管理代码

• 执行可重复的结构更改

• 修复布局指令

• 生成基于文本的单一事实来源

使用Visual Paradigm Online用于：

• 最终视觉定位

• 演示文稿格式化

• 手动调整连接器

• 添加注释和标注

• 为利益相关者准备图表

第 5 部分：示例细化对话

初始请求

为食品配送平台创建 C4 系统上下文图。

细化 1

将客户、餐厅经理、配送司机和运营管理员作为人员添加。

细化 2

将支付提供商、地图与地理定位服务、通知服务作为外部系统添加。

细化 3

移除所有数据库、API、微服务、容器和实现细节。这必须保持为 C4 系统上下文图第 1 级。

细化 4

将所有关系标签重写为简洁的动词短语，并尽可能保持在 10 个单词以内。

细化 5

检查图表中是否存在缺失的关系和不一致的术语。将“食品配送平台”保留为唯一的关注系统。

细化 6

生成 C4-PlantUML 格式的图表，并使其可在 VPasCode 中编辑。

第 6 部分：故障排除

图表包含过多细节

询问：

将其简化为严格的 C4 系统上下文图。移除容器、组件、数据库、API 和技术名称。

图表有太多交叉线

在 VPasCode 中：

• 尝试LAYOUT_LEFT_RIGHT()或LAYOUT_TOP_DOWN().

• 添加有限的Lay_指令。

• 缩短关系标签。

• 减少显示的关系数量。

• 将最终版本移至 VP Online 以进行手动定位。

PlantUML 预览显示错误

检查：

• C4 库包含

• 缺少逗号

• 未闭合的括号

• 标识符拼写错误

• 引用未定义元素的关系

• 引号不匹配

• 元素名称错误

关系必须引用已声明的标识符，例如：

Person(customer, "Customer", "Places orders")
System(platform, "Food Delivery Platform", "Processes orders")

Rel(customer, platform, "Places orders")

GUI 版本与代码版本不同

转换后将两个版本视为独立的编辑表示。请明确决定哪一个作为事实来源：

• 使用VPasCode作为事实来源，如果图表将作为代码维护。

• 使用Visual Paradigm Online作为事实来源，如果利益相关者将频繁进行视觉调整。

避免在未同步的情况下在两个位置进行不相关的更改。

生成的图表使用了错误的 C4 层级

向聊天机器人提问：

仅将此重新生成为 C4 系统上下文图。展示人员、目标系统和外部软件系统。不要展示容器或组件。

最终质量检查清单

在发布图表之前，请确认：

• 图表具有清晰的标题。

• 目标系统显而易见。

• 人员和外部系统已正确分类。

• 关系具有有意义的标签。

• 没有内部实现细节泄露到上下文视图中。

• 名称使用一致的术语。

• 图表在正常缩放比例下可读。

• 关系线不遮挡形状或标签。

• PlantUML 源代码渲染成功。

• VP Online 版本与已批准的架构一致。

• 最终图表已由熟悉该系统的人员审核。

最高效的工作流程是使用 AI 聊天机器人进行快速建模，使用 VPasCode 进行精确且可重复的 C4-PlantUML 编辑，并使用 Visual Paradigm Online 进行最终的视觉优化。这将对话式生成、基于代码的图表可维护性以及基于 GUI 的演示编辑整合到一个流程中。