何时文档需要截图？

在开发文档时，一个常见的问题是：“我应该包含多少截图？” 答案从“一个也不要！”到“所有屏幕都要！”不等。一张图片可能胜过千言万语，但截图常常被用作拙劣文档或糟糕设计的拐杖。最好的答案是，当你需要它们时就使用它们，当你不需要它们时就不要使用。那么，你如何知道何时需要它们呢？

图解难以解释的概念

如果你的界面与用户可能习惯的界面截然不同（或者如果它太杂乱或在其他方面不太好），这是一个很好的迹象，表明你应该包含一些截图。如果你找不到合适的词语来清楚地解释你希望读者做什么，那么在改进界面时，截图可能是一个很好的权宜之计。这里的关键是你希望读者做什么。一般来说，对于用户实际上不与之交互的 UI 元素，你不需要包含截图。

你的受众的技能水平如何？

当然，受众是一个重要的考虑因素。如果读者以前使用过基于 GUI 的桌面，则你无需解释“文件 -> 打印”菜单。如果你是为完全的新手写作，那么这可能是一个好主意。同样，如果读者是经验丰富的用户，则无需截取每个弹出对话框的屏幕截图。“错误：文件未找到”和“错误：无法写入文件”并没有太大的不同，不需要图形化的解释，特别是如果两者的唯一操作都是单击“确定”按钮。

^{Slack 良好使用截图的一个例子；突出显示了 用户界面中新用户可能不熟悉的特定区域。}

少即是多

“但是包含屏幕截图有什么坏处呢？”你问道。主要有四个原因。首先，每次你的 UI 更改时，它们都需要更改，否则它们会过时，你的读者会感到困惑。这是额外的工作。

第二个原因是，如果你正在编写的 UI 是可皮肤化或以其他方式可配置的，则制作屏幕截图的人可能具有与默认布局不同的布局，这会再次使读者感到困惑。（请注意，“我们将只使用默认配置来制作屏幕截图”不一定是一个好的答案，因为下游可能会更改默认值。）

第三个原因是屏幕截图无法翻译。如果你的文档被翻译成多种语言（实际上，难道你不希望你的项目足够受欢迎，以至于多种语言成为必需？），你的翻译人员将不得不在目标语言中重新制作屏幕截图。否则，你翻译的文档将成为二等公民。

最后，也是可以说最重要的是，屏幕截图对可访问性不利。视力受损的用户依靠文本到语音转换来阅读你的文档。屏幕截图不利于屏幕阅读器，因此无论如何你都需要编写良好的文本。

截图不是拐杖

“但是截图增加了一些不错的视觉效果，它们有助于打破文字墙！” 你的论点说服不了我。布局良好的内容也可以打破文字墙。除非你发布纯文本，否则你选择的标记语言可能可以使用某种样式、CSS 或其他方式来帮助视觉吸引力。傻瓜系列丛书是我最喜欢的文档之一，而且大多数书都使用最少的截图。频繁的标注和章节标题可以打破文本。

在编写文档时，尝试在没有截图的情况下进行。描述读者应该做什么或他们看到什么。当你实在无法解释正在发生的事情时，添加你需要的截图。先写文本的心态会使你的写作随着时间的推移变得更好。

本文是 Rikki Endsley 协调的 Doc Dish 专栏 的一部分。要为本专栏投稿，提交你的故事想法 或 联系我们。