工作流可视化器 是做什么的?
当有人想详细了解一个工作流时,纯文字往往不够。流程有其顺序、交接、决策和等待时间。一个合适的图形能让人一眼读懂。它替代长篇文字答案,而不是作为补充。
形状是自由选择的。没有哪种形状有优先级,无论是时间线还是其他形状。流程的结构决定了形状。
何时适用此技能
两个条件同时满足:
- 上下文是工作流、流程或程序(用户自己的、之前讨论过的、或需要从头解释的)。
- 用户希望更深入:“详细地”、“更精确地”、“逐步地”、“再次解释”、“它是如何运行的”。
如果“工作流”一词只是顺带提及,且问题可以快速回答,则在聊天中简短回复即可。为每次顺带提及都生成图形会降低其价值。
步骤
- 明确流程。 从对话、文件或用户指定的来源中获取流程。如果缺少关键要素,简短地问一次。不要虚构步骤、时长或工具。任何未经证实的内容都标记为“开放”。
- 读取结构,然后选择形状。 参见下一节。在聊天中用一句话说明你选择的形状及其原因。用户可以用一句话否决你的选择。
- 大纲。 总共 4 到 10 个步骤,分组为 2 到 4 个阶段或泳道。更多步骤会稀释图形;相反,应总结子流程。
- 填充每个步骤。
- 时间标记或位置:实际时长、时间点或顺序(“步骤 3”)。不要猜测时钟时间。
- 图例中的符号。
- 标题(名词,简短)和一至两句话,说明发生了什么及其原因。
- 可选的重要框:仅当信息能决定流程成败时使用(前提条件、错误来源、批准)。
- 可选的具体框:一个具体的图像、例子或类比,使抽象的步骤易于理解。这个图像是用来解释的,而不是装饰。
- 构建图例。 仅包含图形中出现的符号以及所选形状的要素。图例位于顶部。
- 以页面形式交付。 基于
assets/base-template.html(标记、页眉、图例、框)构建,并按照references/shapes.md的说明添加所选形状的结构。对于流程图,assets/flowchart-example.html中有一个完成的示例:重用其 CSS 并替换内容。页面标题采用工作流的名称,例如“文档审批流程”。如果你的环境可以发布页面或工件,请在此处发布;否则交付一个自包含的 HTML 文件。 - 在聊天中回复。 一到两句话:所选形状及其原因,以及任何未解决的问题。不要重复图形的内容。
选择形状
先读取工作流的结构,然后决定。以下问题会有所帮助:
- 是否存在决策,其结果会返回(循环),或路径再次汇合,并且读者需要能够用手指追踪路径? → 流程图
- 路径是否在决策处分叉,并在不同位置结束,不再返回? → 分支图
- 是否有多个人、工具或角色承担流程的各个部分,难点在于交接,且没有循环? → 泳道图
- 流程是否在最后一步后原样重新开始,或者结果反馈到下一次运行,且中间没有决策? → 循环图
- 是否有多条并行运行的线索,并且需要在某处汇合? → 平行轨道图
- 流程的核心是否是一系列按时间顺序的步骤,且等待时间、截止日期或时长很重要? → 时间线图
- 工作流是否混合了多种特性?选择读者最可能出错的那个。次要特性成为信息框或位置标签:流程图可以显示步骤的发生位置,而不需要泳道。
循环是改变形状的最常见原因。将其隐藏在信息框中会掩盖它,而这恰恰是读者容易出错的地方。如果存在循环,流程图通常是最诚实的形状,即使泳道图或时间线图乍看之下也很适合。
不要根据外观或习惯来选择。与结构不匹配的形状会歪曲流程:一个轴线会隐藏替代方案,没有真正交接的泳道只是装饰。
每种形状的确切构建规则位于 references/shapes.md 中。仅读取所选形状的章节。
符号
全部为角形,没有圆形。形状使用 CSS 而非字符绘制,以便在任何地方看起来都一样。
| 符号 | 形状 | 含义 |
|---|---|---|
| 操作 | 实心正方形 | 处理或产出了某些东西 |
| 决策 | 空心正方形 | 流程在此处分支 |
| 检查点 | 菱形 | 检查、签核、批准 |
| 交接 | 三角形 | 结果移交给人员、工具或阶段 |
| 等待 | 水平条 | 没有主动发生任何事,时间流逝 |
| 开放 | 虚线正方形 | 信息缺失或未经证实 |
仅在流程确实需要时添加其他符号,并在图例中解释它们。
样式
模板带有中性默认样式:温暖的纸张背景、接近黑色的墨水、一种仅用作表面的浅色调强调色,以及系统字体。所有颜色都是 :root 中的令牌。如果用户有品牌或设计系统,只更改这些令牌;不要重新设计结构。
- 纸张作为背景,墨水用于标题,石墨色用于正文,一种沉稳的色调用于安静表面,发丝线用于规则。
- 强调色仅用作表面,绝不用于文本或线条颜色。其上的文本始终是墨水。每页最多一个大的强调色带;阶段和泳道标题下方的小标记条(10px)可以重复。
- 一种字体族。通过粗细和字间距实现层级;字间距仅用于大写字母。
- 无阴影、渐变、圆角、表情符号或感叹号。列表使用墨水方块。连接线为直线直角,2px 墨水。
- 页面在纸上保持单一主题。所有颜色均显式设置,以便在浅色和深色 UI 中读取效果相同。
- 移动优先,无页面水平滚动。任何需要更宽的(如泳道)在其自己的容器中滚动。
不要发明新的颜色、字体或形状。如果系统缺少某些内容,指出差距并在令牌范围内解决。
语言
以用户使用的语言编写图形。保持事实性、基于名词且简短。不填充内容,不谈潮流。解释可以生动但要精确:一个强烈的图像胜过三个软弱的图像。
交付前检查清单
- 形状遵循工作流的结构,并且聊天句子说明了原因。
- 每个循环都绘制为路径,而不仅仅在文本中提到。
- 每个时间声明都有文档记录或仅标记为顺序。
- 任何未经证实的内容都带有“开放”符号。
- 图形中的所有符号都出现在图例中,并且没有其他符号。
- 强调色仅用作表面,绝不用于文本或线条。
- 文本没有超出边缘,即使在 400px 宽度下也是如此。
- 聊天文本不重复图形的内容。