用户流程 - Archyl Docs

记录跨架构的用户和数据流程，可视化交互序列

用户流程

Archyl 中的用户流程让您记录跨架构的交互序列。可视化用户、数据或请求如何在系统中流动。

什么是流程？

流程代表通过架构的一系列步骤：

  • 用户旅程：登录、结账、注册
  • 数据流：订单处理、数据同步
  • 系统交互：API 调用、事件链
  • 错误处理：故障场景、重试

流程中的每个步骤引用架构中的关系，创建事物如何运作的关联视图。

创建流程

从流程选项卡

  1. 前往项目中的 流程 选项卡
  2. 点击 创建流程
  3. 输入名称和描述
  4. 通过选择关系添加步骤
  5. 点击 保存

流程结构

每个流程包含：

字段 描述
名称 简短、描述性名称（如"用户登录流程"）
描述 此流程代表什么
步骤 有序的关系引用列表

添加步骤

对于每个步骤：

  1. 从架构中选择一个关系
  2. 步骤显示源、目标和关系标签
  3. 拖动以重新排序步骤
  4. 添加备注以提供额外上下文

查看流程

逐步导航

查看流程时：

  • 步骤按顺序显示
  • 当前步骤在图表上高亮显示
  • 使用上一步/下一步按钮导航
  • 在每个步骤查看完整上下文

动画播放

点击 播放 以动画形式浏览流程：

  • 自动步骤进展
  • 图表上高亮路径
  • 可调节播放速度

分享流程

公开流程链接

用户流程内置公开分享功能：

  1. 打开一个流程
  2. 点击 分享 图标
  3. 复制公开 URL
  4. 与任何人分享

公开视图包含：

  • 逐步导航
  • 架构可视化
  • 流程描述
  • 无需身份认证

嵌入流程

将流程嵌入到外部工具中：

  • Confluence
  • Notion
  • 文档网站
  • Wiki

最佳实践

清晰命名流程

使用面向动作的名称：

  • "用户注册"
  • "订单结账流程"
  • "支付退款流程"
  • "数据同步管道"

保持流程聚焦

  • 每个用户旅程一个流程
  • 5-15 个步骤为理想
  • 将复杂流程拆分为子流程
  • 需要时引用其他流程

添加上下文

使用描述来解释：

  • 为什么存在此流程
  • 谁使用它
  • 何时触发
  • 预期结果是什么

关联到文档

引用相关文档：

  • API 规范
  • 需求文档
  • 解释设计选择的 ADR

流程示例

电商结账

  1. 用户 → 购物车服务："查看购物车"
  2. 购物车服务 → 库存："检查可用性"
  3. 用户 → 结账服务："开始结账"
  4. 结账服务 → 支付："处理支付"
  5. 支付 → 订单服务："创建订单"
  6. 订单服务 → 通知："发送确认"

API 认证

  1. 客户端 → API 网关："携带凭据请求"
  2. API 网关 → 认证服务："验证令牌"
  3. 认证服务 → 用户数据库："查找用户"
  4. 认证服务 → API 网关："返回声明"
  5. API 网关 → 后端："携带用户上下文转发"

后续步骤