“言语是有意义的”是我最喜欢的表达之一。我经常开玩笑地使用它,但在编写文档时,这是一个重要的考虑因素。我通常是一个喜欢以极具艺术天赋的方式运用文字的人,但当涉及到编写技术文档时,我在措辞方面变得更加慎重。我不知道这种习惯是从什么时候开始的,但我注意到这些年来,我在用词方面变得越来越谨慎。本文介绍了您在写作时可以牢记的三个注意事项以及相关的资源。
精通技术的作者习惯于像他们精通技术一样写作。不幸的是,读者并不总是那么精通,特别是当他们是项目新手时。最好使用简单、明确的术语,并解释新的或特定于主题的术语。IEEE 专业传播协会就如何使用清晰的措辞提供了出色的指导。
以从未使用过计算机的人作为一个极端的例子。习惯“单击”涉及鼠标(或触控板),而“按下”涉及键盘这个概念可能需要一段时间才能适应。如果文档开始交替使用这些术语,读者可能会感到困惑。经验更丰富的读者可以从上下文中弄清楚正确的操作,但是这种不一致性对于刚开始学习计算机使用基础知识的人来说可能会感到不适。
正确选择措辞还有另一个优点:读者花在弄清楚你的意思上的时间越少,他们花在理解你想表达的内容上的时间就越多。如果你的文档具有一致的用词,其他人的文档也具有一致的用词,那么你的读者的生活就会变得更好一些。微软有一个全面的用户交互术语词汇表。
用词选择的一致性不仅对你的读者有帮助,对你的翻译人员也有帮助。字符串越一致,翻译所花费的精力就越少。
说到翻译,更简单的词汇可以减少翻译人员在找到正确的翻译之前不得不查找单词的次数。坚持使用常用词汇也有助于你以读者更容易理解的方式解释概念。XKCD 漫画Up Goer Five就是一个很好的例子。牛津 3000™ 词汇表是一个很好的常用词汇列表。当然,使用更简单的词汇通常意味着使用更多的词汇,因此简单和简洁常常是矛盾的。如果你了解你的受众,你就可以找到适当的平衡。
所以请记住,当您写作时:要简洁、要一致、要简单。言语是有意义的。
7 条评论