Documentation 技术文档中的屏幕截图有多重要？

我们所有人都经历过用新软件学习新任务的痛苦

示例：

• 创建新的ASP.NET MVC项目
• 创建新的WordPress插件
• 将本地MySQL数据库迁移到远程服务器
• 等等

问题是：

• 截图在帮助我们学习方面有多有用
• 还是详细的步骤列表更有助于帮助我们学习

--

其他背景：

此对话部分由以下人员开始：

令人讨厌的事。已经 不必要的截图，以及 缺少的说明 必要的截图

我知道这一点 看起来有点矛盾，但是 作者应该知道什么时候 屏幕截图是必要的，当一个 不是。如果步骤令人困惑，请添加一个 截图。如果你不需要动脑筋， 别说了。如果你有一个任务 大约只有7步长，但是 作者每天都会附上一张截图 一步一步，它会使任务膨胀 让它看起来比它更艰难 是但有时，每一个字在 世界无法描述信息 在一个屏幕截图中传达

而且：

技术写作中的视觉效果是 重要的。根据"关于 使用94页手册与 使用25张闪存卡……人们学会了 更快速地使用闪存卡 涵盖了关键想法和提示，并且[没有 按部就班的指导。”

这个 金·内森的轶事说明了这一点 大多数用户对文档的反应： “我第一次得到的实际反馈来自 新员工（发展总监） 他对我没有这么做感到失望 包括一个图片故事板 流程。结果是他 我的任何一本书都没有读太多 只需浏览一下文档即可

这两篇文章展示了对什么是“不必要的截图”的不同看法。截图的创建和维护非常耗时；因此技术作者讨厌截图。然而，用户似乎喜欢截图，有证据表明，视觉学习更受欢迎，也更有效

---

那么，截图在技术写作中有多重要呢？

就像技术交流中的大多数事情一样，截图的重要性取决于你的受众。如果你在为那些整天都在终端会话中的人准备文档，他们可能并不迫切需要这种视觉天赋。但是如果你想教他们如何做截图的话作为一位只使用电脑查看电子邮件的祖母，这些截图可能是你的文档中最重要的东西。它取决于你的读者已经拥有什么样的知识和能力，以及他们对学习的期望

---

因此，如果截图对观众来说不重要，那么它们对技术作者来说也可能不重要。但即使它们很重要，也不一定意味着截图值得做。例如，如果你没有资源（主要是时间）为了让截图保持最新，它们可能会成为观众的困惑点。选择制作插图（无论是截图、截图还是线条艺术）不仅仅是了解受众的需求，更重要的是了解自己的能力。

屏幕截图只有在为材料增加价值的情况下才对文档很重要。识别特定类型的读者只会有助于开发文档的深度。在某些情况下，你不会告诉开发人员如何使用鼠标事实上，他们可能会觉得你建议他们使用鼠标是一种侮辱

作为一名近20年的专业作家和技术专家，我可以毫不含糊地说，文档并不像表面上那么复杂。写得清晰、简洁。切中要害。不要喋喋不休地谈论这个和那个，也不要试图变得聪明。聪明令人困惑

也不要一段接一段地唠叨。如果你对截图有一个有效的用途，你可以使用截图和格式化的块引号来打破流程，让阅读变得更有趣。任何人最不希望看到的就是在长篇大论中隐藏一些关键警告

保持一致，不要使用太多花哨的格式。如果您开始标记菜单选项，如：Apple>Dock>Position On Left，您必须始终以相同的方式设置菜单选项的格式。这不仅有助于您的读者阅读，而且可以将您的文字用作参考。当它站立时，更容易找到重要的内容他出去了

颜色也很重要，甚至比图标更重要。颜色能向读者表达自己的想法并产生情感影响。红色突出重要、关键或值得关注的东西。绿色给人一种向前迈进或取得进步的感觉。蓝色是镇定剂，非常适合于有用但不关键的东西

---

最后，不要太担心自己是英语专业的学生，也不要太在意写作规则。文档有助于人们理解自己在做什么，而且不会登上《纽约时报》畅销书排行榜，也不会得到普利策奖。要自然、健谈。只是不要太健谈。了解你的听众会大有帮助。

您的两个示例受众（奶奶和UNIX管理员）显示极端情况，但无助于指导现实世界的决策。几乎所有用例都会处于这些极端情况的中间。这是否意味着大多数用例都需要一些屏幕截图？简短的回答是肯定的。如果我正在为假设的UNIX管理员编写文档，我甚至可能会为一些视觉元素提供一个熟悉的屏幕截图（比如说，某个数据库的web界面）这样读者就可以知道他们是否看到了他们应该看到的东西。但这可能只是其中之一。