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