技术传播的七宗罪

2021-12-30 03:00:10 techwhirl

本文共1950个字,阅读需5分钟

阅读模式 切换至双语

书面交流有很多失败的地方。这些方式中最糟糕的是我所说的七宗罪。避开它们可以降低这种风险,尽管还有足够多的其他罪过(更不用说其他人的罪过了)无法保证。尽管如此,避免这些罪恶会大大降低你沟通失败的风险。 冗长 使手稿尽可能短--但不能短。避免太短的,带有电报意味的句子,也不要去掉“the”和“that”这样的辅助词。有时你需要多加几个词,让读者有时间吸收你所说的话。复杂的概念尤其具有挑战性,因为它们总是比简单的概念需要更多的单词。即便如此,通常也可以在不牺牲肉的情况下修剪脂肪。 假设 在你开始写作之前,问问自己读者必须知道什么才能理解你所描述的内容。更好的办法是问问你的读者。然后首先提供上下文信息。例如,Word 2019 For Mac在功能区中有10个菜单(每个菜单项最多有28个)和9个选项卡(每个选项卡最多有40个项目)。永远不要假设读者知道一个工具在这个功能的聚宝盆中的位置。千万别让他们查那个地方。当然,你可以希望他们愿意搜索在线帮助或谷歌来找到一个功能,但为什么不通过解释他们需要知道什么来节省他们的时间呢? 要求过高 不要把太多的信息塞进一个句子,也不要把太多的概念塞进一个段落。我们应该在每段中包含一个整体概念,在每句话中包含一个辅助主题的一般性建议并不是一成不变的,但这是一个很好的起点,因为它是有效的。即使读者很熟练--很多人并不熟练--为什么要让他们不必要地努力工作呢?此外,避免使用缩略语和缩略语使读者负担过重。这在技术文档中尤其成问题,有时很难看到隐藏在一堆三字母缩略语中的文本。 未能兼容并蓄 性别歧视的语言冒犯并排斥读者。不分性别的语言很容易学,很快就会成为第二天性。例如,使用命令式语句和第二人称“你”消除了产品文档中的许多问题,在需要描述的地方,使用复数解决了许多问题:将“读者应该注意这些警告,以免遭受可怕的命运”与“你应该付出代价……以免遭受痛苦……”相比较,北卡罗来纳大学的指南值得一看(https://writingcenter.unc.edu/tips-and-tools/gender-inclusive-language/),《跨性别语言入门》(https://www.translanguageprimer.org/Primer)也值得一看(https://writingcenter.unc.edu/tips-and-tools/gender-inclusive-language/Primer)。 与此相关的是,我们的受众日益国际化,因此我们必须确保我们的信息不仅仅满足英语读者的需求。翻译你能翻译的地方;在不能使用的地方使用清晰一致的语言。谨慎使用短语动词,避免文化参照物,以简单,直截了当的解释为目标。如果你是为自己国家的读者写作,那么要花更多的时间在细节上挥汗如雨。 不适当的或不小心的重复使用 单一采购是伟大的,如果它有效。出乎意料的是,它经常不会,或者至少会出现故障。如果您重用文本和图形,您是否检查了每次重用,以确保它在每个新上下文中都能完美工作?在学习这种方法的初期,当您还在学习如何编写以供重用时,这可能是很棘手的。但是,即使你已经掌握了这项技能,也很容易犯错误,因为你指定了从文本库或数据库中提取的错误信息块。(你会惊讶地发现从菜单中选择错误的项目是多么容易。或者你可能不会。) 如果用于识别和检索信息的命名法设计得不是很好,那么情况尤其如此。必须始终有人审查最终产品,以确保您重用的所有东西在新的上下文中都能很好地工作。 未能测试您的指示 接口和功能在开发过程中会发生变化。你是否测试了几周或几个月前写的描述,以确保它们仍然有效?当您测试时,如果您按照指令实际所说的去做--而不是您认为他们说的,您打算他们说的,或者您已经知道他们应该说的--这样做效果最好。如果但丁生活在今天,他无疑会为那些不使用自己产品的工程师和那些不使用自己指令的技术交流人员增加一个特殊的地狱圈,然后再将指令发布到一个毫无戒心的世界上。 把你的审美目标凌驾于读者的需求之上 当然,对产品特性进行平淡无奇的描述有时会让人厌烦,更不用说每次都盯着同样的高可读性字体。这并不意味着你应该拥抱你内在的艺术家,创造出令你高兴的艺术作品,但那些对你的读者来说是不可用的。(我已经不记得有多少次我把一本书放回书架而不是买了,因为它的排版让我的眼睛流血了。) 如果你想要有创造力,就开个博客,用你的…嗯…特质的选择来惩罚它的读者。但是当你在练习技术沟通时,坚持简单,清晰,经过验证的设计选择。 出去吧,别再犯罪了! 不像其他致命的罪孽,这些更有可能让你的观众而不是你进入地狱。如今,人们有足够的事情要担心,而我们却没有给他们其他的事情去处理。努力做得更好!

以上中文文本为机器翻译,存在不同程度偏差和错误,请理解并参考英文原文阅读。

阅读原文