Guide · 使用教程
Eraser 架构图教程:事实清单、节点连线与系统边界核验
用虚构通知服务走通资料整理、AI 生成、事实检查、修正、导出与版本维护。
这篇教程把一份系统说明变成可验收的架构图:先整理事实清单,用 Eraser 生成,逐项核对节点、连接和边界,最后保存源文件、审核记录和导出版本。示例使用虚构的通知服务,操作入口依据官方文档;本文未连接真实仓库或 Eraser 账号进行在线生成。
开始前准备
准备账号、可使用的 AI 额度和一份已脱敏的系统说明。内部主机名、地址、客户数据、凭证和完整网络配置先按组织要求处理。在 Share File 中检查团队访问与 Link access;官方文档列出的默认团队文件链接允许持链接并有账号的人编辑。Private File 仅创建者与受邀协作者可访问,且禁用链接访问;Eraser 价格页当前将该功能放在 Starter 及以上,Free 试点适合公开或虚构资料。
先决定图的用途:这次画“当前组件与连接”,不把部署方案、业务流程和所有错误细节挤进同一张图。对方需要看请求时间顺序时,再生成一张独立时序图。
第一步:整理可追溯的事实
以下来源名称是虚构样例;实际工作替换成自己的设计文档、代码路径、schema 或部署清单,并记录版本。不要把未经确认的口头猜测列为现状。
| 编号 | 已确认事实 | 应核对的来源 |
|---|---|---|
| F1 | 有 Browser、API、Postgres、Queue、Worker、Mail Provider 六个组件 | 架构说明与部署清单 |
| F2 | Browser 通过 HTTPS 调用 API | 前端请求配置与 API 文档 |
| F3 | API 用 SQL 将通知任务与收件人信息写入 Postgres | 数据模型与服务代码 |
| F4 | API 向 Queue 放 task_id,Queue 将 task_id 交给 Worker | 队列生产/消费代码 |
| F5 | Worker 读写 Postgres,取得收件人并更新任务状态 | Worker 与数据访问代码 |
| F6 | Worker 用 SMTP/TLS 调用外部 Mail Provider | 邮件配置与发送代码 |
| F7 | 服务端边界内包含 API、Postgres、Queue、Worker;Browser 和 Mail Provider 在边界外 | 系统范围与网络说明 |
| F8 | 邮件超时最多重试三次,按 task_id 管理幂等与状态;不新增另一个重试服务 | 运行配置与故障测试说明 |
共有六个节点与六条有向连接:Browser→API、API→Postgres、API→Queue、Queue→Worker、Worker→Postgres、Worker→Mail Provider。F8 作为说明注释,不额外虚构节点。真实系统的幂等实现必须测试,图上写出规则不能证明已经实现。
第二步:生成第一版
在 Eraser 的画布插入菜单中进入 AI Diagram,或按官方文档的 ⌘/Ctrl+J 入口;输入自然语言资料并选择架构图类型。界面名称可能随版本调整,按当前账号的 AI 图表入口操作。
复制这个提示模板,再附上事实表:
为虚构的通知服务绘制“当前架构”组件图,只使用 F1–F8。
必须恰好包含以下六个节点:
Browser、API、Postgres、Queue、Worker、Mail Provider。
必须包含六条有向连接并标注含义:
Browser -> API:HTTPS,提交通知请求
API -> Postgres:SQL,保存任务与收件人
API -> Queue:只发送 task_id
Queue -> Worker:消费 task_id
Worker -> Postgres:SQL,读取收件人与更新状态
Worker -> Mail Provider:SMTP/TLS,发送通知
服务端边界内只包含 API、Postgres、Queue、Worker。
Browser 与 Mail Provider 放在边界外。
F8 写成故障处理注释,不增加组件或连接。
不添加缓存、负载均衡器、网关或部署平台。
不足的信息列入待核查清单,不补成现状。
节点名称与协议标签必须清晰可读,优先减少连线交叉。
常见问题
- AI 架构图生成后应先检查什么?
- 对照原始资料检查节点、连线方向、协议、数据内容、系统边界和故障说明,先修事实再调样式。
- 这份教程是否连接了真实仓库生成?
- 没有。教程按官方文档编写,使用虚构通知服务,实际账号操作与业务资料仍需自行验收。
- 内部资料使用免费层需要注意什么?
- 检查团队文件和 Link access;Private File 从付费计划提供。免费试点优先使用公开、脱敏或虚构资料。
- 六节点、六连线是所有架构图的要求吗?
- 不是。它是本例的已确认事实;真实系统应根据自己的来源清单确定节点和关系。
- 应该修改画布还是图表代码?
- 先检查实际输出格式。当前架构图与流程图通常为 freeform,Code (DSL) 设置或其他图类型可能采用图表代码。
- 导出 PNG 后怎样持续维护?
- 保存源画布或代码/结构数据、事实表、来源版本、审核记录和权限设置;变更后复核受影响的节点与关系。