可视化文档

可视化文档是主要通过图像来说明产品、流程或系统的文档，包括带标注的截图、示意图、短视频和分步图片序列，并辅以简短的文字。它直接向读者展示每一步屏幕应有的样子，而不只是用文字描述。

常见形式包括操作指南、入职培训资料、标准作业程序、版本说明、缺陷报告和培训演示文稿。截图是最常用的元素，因为它与用户实际看到的画面完全一致。示意图用于说明结构，短视频或 GIF 则能展示静态图片无法表现的动态过程。

可视化文档的价值

读者通常先扫视、后细读。在正确的按钮上标出编号的截图，能让读者确认自己操作到了正确的位置，从而减少出错。可视化指南也比长篇文字更容易跨越语言障碍，还能减少“某个设置在哪里”这类重复的支持咨询。

可视化文档的使用场景

• 帮助中心和知识库。
• 支持、财务和运营团队的内部流程文档。
• 展示配置界面的开发者文档。
• QA 报告和缺陷工单。
• 新员工培训。

文档工作流中的截图

1. 截取每个步骤，最好每个操作对应一张截图。
2. 将图像裁剪或取景到相关区域。
3. 添加步骤编号、箭头和简短标签。
4. 模糊处理隐私数据。
5. 导出为 PDF 或网页图片并发布。

Temposhot 的 Action Capture（Command+3）会在每次被接受的点击之前保存目标画面，并可以根据所点击的元素为步骤命名，默认使用 Click "[[element-name]]"。Documents 编辑器可以添加 Step Numbers 和取景，导出时生成 PDF 或页面图片。

常见错误

• 只有一个面板重要，截图却显示了整个屏幕。
• 界面更新后仍在使用过时的图片。
• 各步骤之间的尺寸和标注样式不一致。
• 发布的图片中残留隐私数据。

总在重复截取同样的画面？

用 Action Capture 录制一次操作流程，然后在 Documents 中编辑。请参阅 Action Capture。

常见问题

一份指南应该包含多少张截图？

一个合理的默认做法是：每个会改变屏幕的操作配一张截图。不需要图示的步骤可以省略。

如何让截图保持最新？

每次界面变化后，重新截取受影响的步骤，并为每个版本保留原始图片。

参考资料

• 维基百科：软件文档
• Google 开发者文档风格指南

相关资源

• Action Capture 指南：根据点击生成分步指南。
• 标注与取景：步骤编号和画面聚焦。
• Documents 导出：导出 PDF 和页面图片。