文档应简洁、一致且简单

尚无读者喜欢此内容。
Typewriter keys

April Killingsworth。Rikki Endsley 修改。CC BY-SA 2.0。

“言语是有意义的”是我最喜欢的表达之一。我经常开玩笑地使用它,但在编写文档时,这是一个重要的考虑因素。我通常是一个喜欢以极具艺术天赋的方式运用文字的人,但当涉及到编写技术文档时,我在措辞方面变得更加慎重。我不知道这种习惯是从什么时候开始的,但我注意到这些年来,我在用词方面变得越来越谨慎。本文介绍了您在写作时可以牢记的三个注意事项以及相关的资源。

精通技术的作者习惯于像他们精通技术一样写作。不幸的是,读者并不总是那么精通,特别是当他们是项目新手时。最好使用简单、明确的术语,并解释新的或特定于主题的术语。IEEE 专业传播协会就如何使用清晰的措辞提供了出色的指导。

以从未使用过计算机的人作为一个极端的例子。习惯“单击”涉及鼠标(或触控板),而“按下”涉及键盘这个概念可能需要一段时间才能适应。如果文档开始交替使用这些术语,读者可能会感到困惑。经验更丰富的读者可以从上下文中弄清楚正确的操作,但是这种不一致性对于刚开始学习计算机使用基础知识的人来说可能会感到不适。

正确选择措辞还有另一个优点:读者花在弄清楚你的意思上的时间越少,他们花在理解你想表达的内容上的时间就越多。如果你的文档具有一致的用词,其他人的文档也具有一致的用词,那么你的读者的生活就会变得更好一些。微软有一个全面的用户交互术语词汇表

用词选择的一致性不仅对你的读者有帮助,对你的翻译人员也有帮助。字符串越一致,翻译所花费的精力就越少。

说到翻译,更简单的词汇可以减少翻译人员在找到正确的翻译之前不得不查找单词的次数。坚持使用常用词汇也有助于你以读者更容易理解的方式解释概念。XKCD 漫画Up Goer Five就是一个很好的例子。牛津 3000™ 词汇表是一个很好的常用词汇列表。当然,使用更简单的词汇通常意味着使用更多的词汇,因此简单和简洁常常是矛盾的。如果你了解你的受众,你就可以找到适当的平衡。

所以请记住,当您写作时:要简洁、要一致、要简单。言语是有意义的。

标签
User profile image.
Ben Cotton 受过气象学家的培训,但天气是一个很棒的爱好。Ben 在红帽公司担任 Fedora 项目经理。他是《开源项目项目管理》一书的作者。在 Twitter (@FunnelFiasco) 或 FunnelFiasco.com 上找到他。

7 条评论

关于文档的另一点是,它需要解释如何使用某物(软件、硬件),而不是所有按钮的功能。例如,如何使用我的新 CD 音响与用户指南不同,用户指南会继续介绍按钮、模式等。人们想知道如何看时间,而不是时钟的内部工作原理。大多数 Linux 应用程序的用户文档似乎都侧重于按钮和模式,而不是告诉用户如何实际使用该应用程序。

这是一个很好的观点。“这里是所有可能选项的巨大列表”是有用的,但那应该是“如何使用这个东西!”的附录。

回复 作者:dave (未验证)

添加到翻译建议 - 今天的大部分翻译最初是由机器完成的,翻译人员进来验证/修复任何问题。不仅用词选择的一致性,而且短语的一致性从长远来看可以节省$$,因为机器学习了短语,然后每次重复该短语时都可以翻译。(这里没有使用确切的本地化术语,但希望大家能明白这个意思)。

还有一个日益增长的趋势是让作者也参与到应用程序的 UX/UI 中,以帮助避免定义每个按钮的需求。通过内置于应用程序的上下文帮助,用户可以右键单击或悬停等来获得即时的“按钮”定义。这使得文档可以专注于“如何使用这个东西!”等有趣的事情 :-)

良好的意图和一些好的建议,但需要澄清一下。简单语言和简单文档之间存在真实而重要的区别。

文档应该清晰明了。在文档和其他写作中使用简单语言(通常称为朴素语言)有很多好处。然而,这并不意味着文档本身需要简单。有时文档应该是复杂的 - 包括复杂的信息。文档的简单性(或复杂性)应根据受众和文档的目的而变化。

作者应该了解他们的受众的需求和知识,然后适当地写作。例如,为经验丰富的工程师安装软件编写的有效管理指南与为同一软件的非技术最终用户编写的指南会有所不同。熟练的作者应该能够评估他们潜在的读者(进行受众分析)并相应地调整他们的写作。

关于朴素语言有很多可用的信息。对我来说,我发现首字母缩略词 KISS - Keep It Simple Stupid(保持简单,笨蛋) - 是一个很好的提醒,并且通常对任何作家来说都是一个很好的建议。不要过度写作或提供过于复杂的信息。在你的文档中要直接和坦率。

对于文档,我一直建议遵循 4C 原则。正确 (Correct) - 清晰 (Clear) - 简洁 (Concise) - 一致 (Consistent)。对此有一些变体 - 有时包括全面 (Comprehensive) 和其他 C。我认识的最优秀的作家都在不断挑战自己。

感谢您的评论,Mary。这是一个很好的建议(如果您稍微扩展一下,它本身可能就是一篇好文章)。我同意了解并适当地定位受众是关键。

回复 作者:Mary Arrotti (未验证)

关于术语的简单说明:写关于“...术语词汇表”是一种同义反复(重复相同的术语),因为 _glossary_ 本身就是术语列表...

回复 作者:bcotton

© . All rights reserved.