跳转至

EA 交付

EA 交付模块管理架构项目及其工件 —— 图表和架构工作说明书(SoAW)。它提供所有正在进行的架构项目及其交付物的统一视图。

EA 交付管理

项目概览

页面围绕项目卡片组织。每个项目显示:

字段 描述
名称 项目名称
子类型 创意、计划、项目或史诗
状态 正常、有风险、偏离、暂停或已完成
工件 关联的图表和 SoAW 文档数量

您可以在卡片库视图和列表视图之间切换,并按状态(活跃或已归档)筛选项目。

点击项目可展开显示其所有关联的图表SoAW 文档

架构工作说明书(SoAW)

架构工作说明书(SoAW)TOGAF 标准(开放组架构框架)定义的正式文档。它确定了架构参与的范围、方法、交付物和治理。在 TOGAF 中,SoAW 在准备阶段阶段 A(架构愿景) 期间产生,作为架构团队与其干系人之间的协议。

Turbo EA 提供内置的 SoAW 编辑器,具有 TOGAF 对齐的章节模板、富文本编辑和导出功能 —— 因此您可以直接在架构数据旁边编写和管理 SoAW 文档。

创建 SoAW

  1. 点击项目卡片上的 + 按钮,然后选择「新建 SoAW」
  2. 输入文档标题
  3. 编辑器打开并显示基于 TOGAF 标准的预构建章节模板

SoAW 编辑器

编辑器提供:

  • 富文本编辑 —— 完整的格式工具栏(标题、粗体、斜体、列表、链接)由 TipTap 编辑器驱动
  • 章节模板 —— 遵循 TOGAF 标准的预定义章节(例如问题描述、目标、方法、干系人、约束、工作计划)
  • 行内可编辑表格 —— 在任何章节中添加和编辑表格
  • 状态工作流 —— 文档通过定义的阶段进展:
状态 含义
草稿 正在编写,尚未准备好审核
审核中 已提交供干系人审核
已批准 已审核并接受
已签署 正式签署确认

签署工作流

SoAW 被批准后,您可以请求干系人签署。点击请求签名,然后使用搜索字段按姓名或电子邮件查找并添加签署人。系统跟踪谁已签署并向待签署人发送通知。

预览和导出

  • 预览模式 —— 完整 SoAW 文档的只读视图
  • DOCX 导出 —— 将 SoAW 下载为格式化的 Word 文档,用于离线共享或打印

架构决策记录(ADR)

架构决策记录

架构决策记录(ADR) 记录重要的架构决策及其背景、后果和考虑过的替代方案。ADR 提供了关键设计选择背后原因的可追溯历史。

ADR 概览

EA 交付页面有一个专用的决策选项卡,以 AG Grid 表格显示所有 ADR,并配有持久的筛选侧边栏,类似于清单页面。

表格列

ADR 表格显示以下列:

描述
参考编号 自动生成的参考编号(ADR-001、ADR-002 等)
标题 ADR 标题
状态 彩色标签显示草稿、审核中或已签署
关联卡片 与关联卡片类型颜色匹配的彩色胶囊(例如,应用程序为蓝色,数据对象为紫色)
创建日期 创建日期
修改日期 最后修改日期
签署日期 ADR 签署日期
修订版 修订编号

筛选侧边栏

左侧持久的筛选侧边栏提供以下筛选条件:

  • 卡片类型 —— 带有与卡片类型颜色匹配的彩色圆点的复选框,用于按关联的卡片类型筛选
  • 状态 —— 按草稿、审核中或已签署筛选
  • 创建日期 —— 从/到日期范围
  • 修改日期 —— 从/到日期范围
  • 签署日期 —— 从/到日期范围

快速筛选和右键菜单

使用快速筛选搜索栏在所有 ADR 中进行全文搜索。右键点击任意行可访问包含编辑预览复制删除操作的右键菜单。

创建 ADR

ADR 可以从三个位置创建:

  1. EA 交付 → 决策选项卡:点击 + 新建 ADR,填写标题并可选择关联卡片(包括项目)。
  2. 项目「+」按钮(项目选项卡):从菜单中选择新建架构决策 — 项目将作为卡片关联自动添加。
  3. 卡片资源选项卡:点击创建 ADR — 当前卡片将自动关联。

在所有情况下,您都可以在创建过程中搜索并关联其他卡片。项目通过与其他卡片相同的卡片关联机制进行关联,这意味着一个 ADR 可以关联多个项目。编辑器打开并显示背景、决策、后果和考虑的替代方案等章节。

ADR 编辑器

编辑器提供:

  • 每个章节的富文本编辑(背景、决策、后果、考虑的替代方案)
  • 卡片关联 —— 将 ADR 连接到相关卡片(应用程序、IT 组件、项目等)。项目通过标准的卡片关联功能进行关联,而非专用字段,因此一个 ADR 可以引用多个项目
  • 相关决策 —— 引用其他 ADR

签署工作流

ADR 支持正式的签署流程:

  1. 草稿状态创建 ADR
  2. 点击请求签名并按姓名或电子邮件搜索签署人
  3. ADR 转为审核中 —— 每位签署人收到通知和任务
  4. 签署人审核并点击签署
  5. 当所有签署人都已签署后,ADR 自动转为已签署状态

已签署的 ADR 被锁定,无法编辑。要进行更改,请创建新修订版

修订

已签署的 ADR 可以修订:

  1. 打开已签署的 ADR
  2. 点击修订以基于已签署版本创建新草稿
  3. 新修订继承内容和卡片关联
  4. 每次修订都有递增的修订编号

ADR 预览

点击预览图标查看 ADR 的只读格式化版本 —— 在签署前进行审查时非常有用。

资源选项卡

卡片资源选项卡

卡片现在包含一个资源选项卡,整合了以下内容:

  • 架构决策 —— 与此卡片关联的 ADR,以与卡片类型颜色匹配的彩色胶囊显示。您可以关联现有的 ADR,也可以直接从资源选项卡创建新的 ADR —— 新 ADR 会自动关联到该卡片。
  • 文件附件 —— 上传和管理文件(PDF、DOCX、XLSX、图片,最大 10 MB)。上传时,从以下选项中选择文档类别:架构、安全、合规、运维、会议纪要、设计或其他。类别以标签形式显示在每个文件旁边。
  • 文档链接 —— 基于 URL 的文档引用。添加链接时,从以下选项中选择链接类型:文档、安全、合规、架构、运维、支持或其他。链接类型以标签形式显示在每个链接旁边,图标会根据所选类型变化。