“你有鼻咽炎。”
对于大多数人来说，医生对这种说法的反应可能是：“那是什么？我如何处理这些信息？ 我要死了吗？”但是，如果他简单地说，“您的鼻子和喉咙发炎了。 很有可能，您的反应不会那么混乱和惊慌，您将确切知道该如何处理这些信息。 只需去买一些感冒药。
当涉及技术写作时，信息可能很复杂，难以理解，而且简直无聊。 有很多方法可以共享这些信息，但是，牢记两个主要问题很重要。
- 谁是你的听众？
- 信息及其目的是什么？
以错误的方式生产技术文档会给公司造成数千美元的损失，因为如果没人知道如何使用您的产品，这可能会损害您的业务。 当您的听众是普通大众时（无论您身处哪个行业），保持沟通的简单性很重要，尤其是涉及大量技术文档的沟通。 尽管您可能拥有工程学学位，但隔壁的60岁的史密斯太太可能没有，而且当她只想知道如何重新启动计算机时，可能不想读教科书。 作为非技术人员撰写技术文章时，请记住以下提示。
更多如何，更少原因
当需要查阅用户手册时，一般用户可能不想阅读有关平板电脑突然冻结的所有技术原因。 他们更有可能只是想知道如何解决它。 首先要关注您的写作对象，以及为什么他们会首先参考本文档，然后直接说清楚。
相关：3个要考虑的重要UXO策略
摆脱行话，首字母缩写词和过多的细节
对您来说完全有意义的东西，可能对其他人毫无意义。 首字母缩略词，行话和流行语证明您在该领域知识渊博，但是您永远不应假定读者已经知道。 保持所有内容尽可能简单易懂。
清晰地组织内容
当涉及到内容的结构时，如何组织内容对用户至关重要。 更好地组织内容的一些方法是：
- 使用标题进行签名并帮助读者确定要点
- 在每个句子或观点中讲一个概念
- 使用列表或项目符号来帮助简化复杂的概念
- 使用视觉效果，图形或图表
让非技术人员测试您的工作
让没有任何技术知识的局外人阅读您的工作将有助于微调语言和需要改进的领域。 如果您正在编写说明手册，请他们实际测试您的说明以查看需要更改的内容以及您是否已有效传达了信息。
总是回到两个最重要的问题。 这是给谁的？ 信息及其目的是什么？ 最终产品应该尽可能地易于用户理解，这就是为什么拥有一支专业且训练有素的技术写作团队对于拥有大量技术文档的公司的成功至关重要的原因。
最初于 2017 年10月16日 发布在 blog.csoftintl.com 上。
