技术文档中的普通语言

by ClickHelp.com的内容管理员Bradley Nice撰写—软件文档工具

最近,我为ClickHelp撰写了一篇文章,内容涉及在技术文档中使用纯语言的重要性,并为想要清楚撰写文章的人提供了11条提示。 让我们来看看主要思想。

技术写作或技术交流是关于向普通受众传递技术信息。 在技​​术文档中使用通俗易懂的语言可以使文章清晰,简洁并且对读者有所帮助。

通俗易懂的语言写作可以帮助目标受众轻松理解信息,避免误解并节省时间,因为它可以使工作第一次完成。

悉尼大学前现代英语语言副教授罗伯特·伊格森(Robert Eagleson)教授将通俗语言描述如下:

  • 朴素的语言是清晰,直接的表达方式,仅使用必要的单词;
  • 这种语言避免了晦涩难懂,夸张的词汇和复杂的句子结构;
  • 这不是在谈论婴儿,也不是英语的简化版。
  • 普通英语的作家让他们的听众专注于信息,而不是被复杂的语言所分散;
  • 他们确保听众容易理解消息。

通俗易懂的语言是在使目标受众首次阅读时可以理解并采取行动。

法律写作是技术写作的一种。 它的显着特征包括语法过于复杂和过于形式化的趋势。 比较以下示例,以了解使用简单语言编写的思想。

前两段包含对读者来说不必要的多余信息,只有最后一段暗示了消息的目的。 此外,整封信以过分正式的方式写着,句子冗长,不常见的单词和陈词滥调,难以阅读。

让我们看看简单的语言是否可以改善本文。

官方消息包含153个单词,而普通语言版本仅使用77个单词。两种消息均分为3个段落,即3个想法,在第二个版本中对其进行了仔细地保留。 同样明显的是,第二条消息更易于阅读和浏览。 所有这些好处都是通过通俗易懂的语言实现的。

继续阅读:技术文档中的普通语言基础知识,您将学到11种普通语言编写技巧!


请按👏掌声按钮,以帮助其他人找到这个故事。 您知道您最多可以放弃掌声吗?

也可以在 Twitter上 关注我

布拉德·尼斯(@nice_brad)| 推特

Brad Nice(@nice_brad)的最新推文。 媒体和设计顾问的设计领域最佳作家

twitter.com

祝你今天愉快!

布拉德利尼斯,
ClickHelp.com上的 Content Manager — SaaS供应商的最佳在线文档工具