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

Question

我们每个人都通过学习新的软件来完成一项新的任务。

示例：

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

问题是：

• 截图在帮助我们学习方面有多有用？
• 还是一份详细的步骤清单对帮助我们学习更有帮助？

--

附加背景：

这次谈话部分是由这个职位开始的

宠物恼怒#5.有不必要的屏幕截图的说明，以及缺少必要的截图的说明。 我知道这听起来有点矛盾，但是作者应该知道什么时候需要截图，什么时候不需要截图。如果是个不需要思考的人，就把它忘了。如果你的任务只有7步长，但作者每一步都有一张截图，它会使任务臃肿，使任务看起来比实际任务更加艰巨。但有时世界上的每一个词都不能描述在一个截图中传达的信息。

还有这篇文章

技术写作中的视觉效果很重要。据“一项关于使用94页手册学习的研究与使用25 flash cards....people的研究相比，使用涵盖关键思想和提示的闪存卡学习速度更快，而不是一步一步地学习。” 金·纳坦( Kim Nathans )的这则轶事反映了大多数用户对文档的反应：“我从一名新员工(开发总监)那里得到了第一份实际反馈，他对我没有包括一个流程流程的图文并茂的故事板感到失望。结果发现，他只看一眼我的文档，而不是看我的任何文档。

这两篇文章展示了关于什么是“不必要的截图”的不同观点。截图的创建和维护是很费时的，因此技术作者讨厌截图。然而，用户似乎很喜欢他们，而且有证据表明视觉学习是他们的首选和更有效的。

所以，屏幕截图在技术写作中有多重要？

Answer 1

就像技术交流中的大多数事情一样，截图的重要性取决于你的观众。如果你在为那些整天在终点站工作的人准备文档，他们可能不会对这种视觉天赋感到绝望。但是，如果你想教一位只使用电脑查看电子邮件的祖母，这些截图可能是你的文档中最重要的事情。它取决于你的读者已经具备的知识和能力，以及他们对学习的期望。

因此，如果截图对观众来说并不重要，那么对他们的技术撰稿人来说，它们也不应该很重要。但即使它们很重要，也不一定意味着截图是值得做的。例如，如果您没有足够的资源(主要是时间)来保持屏幕截图的时效性，它们可能会成为观众的一个困惑点。选择插图(无论是截图还是屏幕或线条艺术)不仅是为了了解你的观众想要什么，还在于了解你自己的能力。

Answer 2

只有当截图增加了材料的价值时，截图才对文档很重要。识别特定类型的读取器只会帮助开发文档的深度。你不会告诉开发人员如何使用鼠标，事实上，他们可能会觉得你说他们在使用鼠标是一种侮辱！

我已经做了近20年的专业作家和技术专家，我可以毫不含糊地说，文档并不像看上去那么复杂。写得清楚简洁。说到重点。不要喋喋不休地谈论这个和那个，也不要试图变得聪明。聪明令人困惑。

也不要喋喋不休地听一段接一段的话。如果你有一个有效的使用截图，你可以使用它们和格式化的区块引号，以打破流，使阅读更有趣。人们最不想看到的就是把一些关键的警告埋在长长的漫漫长河中。

保持一致，不要涉及太多花哨的格式。如果您开始对菜单选择进行标注，如：Apple > Dock > Left上的位置，则必须始终以相同的方式设置菜单选择的格式。它不仅帮助你的读者阅读，而且使用你的写作作为参考。当重要的事情突出的时候，更容易找到它。

颜色也很重要，甚至比图标更重要。色彩能对读者说出心声，并产生情感上的影响。红色作为重要的，关键的，或值得关注的东西而突出出来。绿色给人们一种前进或进步的感觉。蓝色是平静的，对一些有用但不重要的东西来说很好。

最后，不要太担心自己是英语专业的学生，并且在写作时要遵守仔细的规则。文档帮助人们理解他们在做什么，而且它不会最终出现在“纽约时报”的畅销书名单上，也不会得到普利策奖。要自然，善于交谈。只是不要太健谈。了解你的听众会有很大帮助。