截图在技术文档中有多重要?

时间:2011-03-23 14:35:00

标签: documentation screenshot

我们所有人都因使用新软件学习新任务而受苦。

示例:

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

问题是:

  • 帮助我们学习屏幕截图有多大用处?
  • 或者是一个更有助于我们学习的详细步骤列表?

-

其他背景:

此对话部分由this post启动:

  

Pet Peeve#5。有的说明   不必要的截图,和   缺少的说明   必要的截图。

     

我知道这一点   似乎有点矛盾,但是   作家应该知道什么时候   需要截图,何时需要截图   不是。如果步骤令人困惑,请添加一个   屏幕截图。如果这是一个明智的做法,   把它留下来。如果你有任务   只有大约7步长,但是   作家已经包含了截图   一路上,它使任务膨胀   并使它看起来比它更艰苦   是。但有时候每一个字都在   世界无法描述信息   在一个屏幕截图中传达。

还有this article

  

技术写作中的视觉效果是   重要。根据“一项研究   学习使用94页的手册与   使用25张闪存卡......人们学会了   使用闪存卡更快   涵盖了关键的想法和提示,[不是   逐步说明。“

     

此   Kim Nathans的轶事说明   大多数用户对文档的反应:   “我得到了我的第一个实际反馈   新员工(发展总监)   我很失望,因为我没有   包括一个图画故事板   流程。事实证明他   没有那么多读我的   文档只是看一眼就可以了。

这两篇文章展示了对“不必要的截图”构成的不同意见。屏幕截图创建和维护非常耗时;因此技术作家讨厌他们。然而,用户似乎喜欢它们,并且有证据表明视觉学习既是首选也是更有效。

那么,技术写作中的截图有多重要?

2 个答案:

答案 0 :(得分:1)

与技术交流中的大多数事情一样,屏幕截图的重要程度取决于您的受众。如果你正在为那些在终端课程中度过一整天的人准备文档,那么他们可能不会对这种视觉风格感到绝望。但是如果你试图教一个只使用电脑查看她的电子邮件的祖母,这些截图可能是你文档中最重要的事情。它取决于读者已具备的知识和能力以及他们对学习的期望。

因此,如果截图对观众来说并不重要,那么他们对技术作家来说也许并不重要。但即使它们很重要,也不一定表明屏幕截图值得做。例如,如果您没有资源(时间,主要是)保持屏幕截图最新,它们可能会成为观众的混淆点。选择做插图(无论是截图或截屏或艺术线条)不仅仅是要了解观众的需求,还要了解自己的能力。

答案 1 :(得分:1)

屏幕截图只有在文档为材料增加价值时才对文档很重要。识别特定类型的读者只会有助于深入了解文档。您不会告诉开发人员如何使用鼠标,事实上他们可能会发现您建议他们使用鼠标是侮辱性的!

近20年来,作为一名专业的作家和技术专家,我可以毫不含糊地说,文件并不像看上去那么复杂。写得清楚简洁。达到目的。关于这个和那个不要喋喋不休,不要试图变得聪明。聪明令人困惑。

也不要为了段落之后的段落而咆哮。如果您对截图有效,则可以使用它们和格式化的块引用来分解流程并使阅读更有趣。任何人想要的最后一件事就是在一个冗长的漫步中埋下一些重要的警告。

保持一致,不要涉及太多花哨的格式。如果您开始记下菜单选项,请执行以下操作: Apple> Dock>位于左侧,您必须始终以相同的方式格式化菜单选项。它不仅可以帮助您的读者阅读,还可以将您的写作作为参考。当它脱颖而出时,更容易找到重要的东西。

颜色也很重要,甚至比图标更重要。颜色向读者讲话并具有情感影响。红色是重要的,关键的,或者需要关注的东西。绿色让人感觉前进或前进。蓝色是平静的,非常适合有用但不重要的东西。

最后,不要过分担心自己是英语专业,并且要谨慎地写作。文档可以帮助人们了解他们正在做什么,并且不会最终出现在纽约时报畅销书列表中或获得普利策奖。自然而且会话。只是不要太过对话。了解您的受众将有很大帮助。