技术写手指南：如何为非技术受众优化你的写作
浏览：1
巴克励步
我常常在想，为什么那么多优秀的产品，最后却因为一本“天书”般的说明书而劝退了用户？产品手册本该是用户与产品之间的桥梁，但很多企业要么把它当成技术文档堆砌，要么干脆随意糊弄。产品手册建设的核心不是罗列功能，而是让一个完全不懂技术的人，也能在5分钟内搞定他需要的操作。今天这篇关于为非技术受众优化写作的文章，正是很多产品经理和文档团队的死穴——他们总默认用户和自己一样懂行。实际上，绝大多数用户只关心“怎么
我常常在想，为什么那么多优秀的产品，最后却因为一本“天书”般的说明书而劝退了用户？产品手册本该是用户与产品之间的桥梁，但很多企业要么把它当成技术文档堆砌，要么干脆随意糊弄。产品手册建设的核心不是罗列功能，而是让一个完全不懂技术的人，也能在5分钟内搞定他需要的操作。今天这篇关于为非技术受众优化写作的文章，正是很多产品经理和文档团队的死穴——他们总默认用户和自己一样懂行。实际上，绝大多数用户只关心“怎么开机”，而不是“电流如何通过电路板”。
了解读者需求
在开始写第一句话之前，你必须明确你的读者是谁以及他们希望通过阅读文档实现什么目标。为非技术受众写作时尤其如此，因为他们的目标可能与你习惯的不同。
作为一名技术写手，你很可能每天都被产品的细节所吸引，但请记住，你的读者可能并不这么想。正如软件开发顾问 Dave Aronson 指出，写作者可能关心事物如何运作，但典型读者主要想知道如何完成任务。因此，Aronson 建议在为非技术读者写作时，注意不要陷入细节的泥潭。
让我们看一个技术写作的例子，其中作者清楚地识别了读者需求，并据此编写了洗碗机用户指南。在编写手册时，作者将所有可选技术细节降至最低，专注于提供直截了当的指令。例如，该指南列出了门自动落下的问题，并以三个字“增加弹簧张力”提供了解决方案。
💛🧡🧡客户评价：Baklib集中信息，简化我们不断发展的产品的更新，并简化将复杂的流程转化为我们团队易于访问的资源。Baklib确实我需要的一切，甚至更多。
注意作者没有大谈胡克定律或弹簧平衡长度——他们知道读者只对恢复设备运行所需的操作感兴趣。要确保你的文档成功，就要按照读者的期望来写作，就像上面指南的作者那样。
要考虑非技术读者对你的主题的理解和知识水平与你不同，这意味着你可能需要降低技术细节的深度。但也没必要走向另一个极端，过度简化文档，或者更糟，用读者已经知道的信息来填充内容。根据 Google 官方技术写作课程，好的文档会跳过读者已有的知识，只添加他们完成任务所需的内容。
避免使用技术术语
虽然技术语言能促进与其他专家的沟通，但对非技术受众可能有害，因此在为非技术读者写作时应尽量减少使用术语。想想看：当你试图组装刚买的架子或弄清楚如何在 Microsoft Word 中编页码时，你最不想做的就是必须学习什么是 Pozidriv 或状态栏。你的读者也一样。
不幸的是，从社交媒体上的帖子来看，技术写手在文档易懂性方面仍有很长的路要走。那么，如何为非技术读者优化语言呢？最直接的解决方案是尽可能使用简单英语代替专业词汇。一些写作工具，如 Grammarly，会在检测到可以用更简单版本替换的词时提供建议。
然而，有些情况下术语是不可避免的。例如，如果你在编写显示器的用户指南，你必须在某个时刻使用 HDMI 这个词。与其回避相关术语，不如在首次提及时就解释专业词汇、缩写和首字母缩略词的含义。你还可以编写术语表或参考指南来帮助读者。
重点解释原因
尽管技术写作应侧重于提供指令，但有时解释某件事的“原因”并为读者提供背景也很重要。如果你习惯于为专业受众写作，现在要优化内容给非技术读者，就需要将解释背景纳入你的技术写作实践。开发者教育者 Megan Sullivan 建议在给出指令之前先提供背景。据 Sullivan 说，阅读技术文档的人背景各异，技术写手的任务是在展开细节之前建立共同理解。
让我们看一个技术文档的例子，作者巧妙地解释了功能背景而不使文档杂乱或让用户不知所措。Home Depot 的吊扇安装手册列出了风扇有夏季和冬季操作模式，通过按下或释放反向开关来激活。读者可能怀疑如此简单的操作会影响温度，因此说明用简单术语解释每种模式的作用——无需热力学知识。
虽然你不应在读者只想学习如何完成任务的地方过度解释，但谈论产品背景有助于更好地展示其功能。技术写手需要根据文档类型和产品本身确定合适的背景信息量。
优先考虑清晰的文档结构
信息的质量不是技术写作中唯一重要的——文档的组织方式同样重要。你不希望读者在文档中四处寻找下一步操作，因此应将内容按逻辑、易于遵循的顺序组织，从头到尾解释过程，使其易于导航。清晰的文档结构应在读者打开目录时就一目了然。
以下 Mitsubishi AC 指南是组织良好的技术文档的绝佳示例。如你所见，文档从用户安全操作设备所需的信息开始。安全注意事项之后，立即提供了设备部件列表及其插图和名称。读者具备基本知识后，指令展示如何开始使用设备。首先，不同的操作逐一列出，每个都有描述性标题。你还可以注意到这些较小部分内部的清晰结构：每个部分以操作描述开始，并列出激活所需的步骤。
在所有操作都列出后，文档以故障排除部分和常见问题解答结束。正是因为作者考虑了文档的整体结构，读者才能轻松找到所需信息。
使用主动语态
在技术写作中，使用主动语态而不是被动语态通常能使句子更清晰、更直接。对于非技术读者来说，主动语态尤其有效，因为它明确指出了谁执行了动作。例如，说“按下启动按钮”比说“启动按钮被按下”更直接。主动语态减少了歧义，使指令更容易遵循。
编写简洁的说明
为非技术受众写作时，简洁是关键。使用短的句子和段落，避免复杂的从句。每个步骤应只包含一个动作。如果可能，使用编号列表来呈现步骤，这样读者可以轻松跟踪进度。此外，使用描述性标题和子标题来划分内容，帮助读者快速定位信息。
通过实施这些技巧，你可以创建既专业又易于理解的技术文档，确保所有用户都能成功使用你的产品。
