针对非技术受众的有效技术写作

你们有多少人同意这个观点？

与专家沟通比与外行沟通更容易。

当你为技术受众撰写文档或用户手册时，你是在与具备专业知识、理解技术术语和流程的专家交流。

但是，当你为技术知识有限或非技术背景的读者写作时，你该怎么做呢？

有效的沟通是产品成功的关键因素！

—— Jesse James Garrett

一位优秀的技术文档作者明白，为非技术受众进行技术写作需要不同的思维方式和写作风格。其核心是以简化的方式向受众传达信息，使他们能够处理并利用这些信息为自己服务。

在本文中，我们将引导你了解为非技术受众进行技术写作的各个方面。通过阅读本文，你将获得正确的技术写作工具和心态，以便为非技术受众写作。

为什么这很重要？

科技行业是一个自成体系的世界，专家们用他们共同的技术语言交流。但有时，一些技术信息需要传达给非技术受众，目的是：

• 扩大覆盖面和可访问性
• 作为产品理解的辅助
• 避免沟通不畅

从医疗设备说明书到机器用户手册，再到安装指南，关键信息不应淹没在术语的世界里。

并且，作为技术文档作者，你的职责是将专业信息分享给非技术领域的外部人士。我们理解你忍不住想向非技术受众提供他们根本不需要的细节。

然而，作为一名优秀的作者，你必须认识到，你习惯对技术受众使用的术语对非技术受众是行不通的。你必须在术语和信息之间架起桥梁。

为非技术受众进行技术写作有何不同？

首先，最重要的一点。非技术受众的目标可能与你习惯的目标不同。你认为人们为什么阅读技术文档？因为他们想完成某件事，对吗？

你理解你的技术受众想要完成什么，并为他们提供所需。同样，当你理解了你的非技术受众希望从特定内容中获得什么时，你就可以为他们提供相关且易懂的信息。

其次，当你为你所信赖的产品撰写文档时，你多少会被其功能和影响力所吸引。然而，你的受众并不了解，可能不会有同样的感受。虽然你或其他技术爱好者可能对某物的工作原理感兴趣，但用户可能只想知道它对自己是否有益以及如何使用。

请看这个技术写作示例，作者在文中识别了读者的需求，而没有添加皮带摆荡工作原理的技术细节。

来源：thdstatic

作者没有赘述秋千的摆动细节，而是通过再次提及，清晰地指出了压紧挂钩这一重要部分。作者明白读者只关心如何安装和使用秋千，但同时也会让读者意识到确保产品安全所需的环节。

在为非技术受众写作时，必须注意以下几点：

1. 最终用户的目标
2. 缩减技术细节
3. 写作需符合读者的预期

来源：Google Developers

为非技术受众写作时的注意事项

在了解如何为非技术受众写作之前，我们先来看看哪些是应该避免的。

• 过多解释“为何使用”而非“如何使用”
• 过多使用行话、缩略语和细节
• 使用生僻词汇和冗长句子

现在，让我们携手采用技术写作的方法来为非技术受众写作。

1. 了解你的受众

你不是在为同行写作，因此必须使用他们的语言。保持对话式的、吸引人的语气。将读者的注意力引导到他们需要做的事情上。

2. 同时，目标也很重要

除了为谁写作，你还必须考虑为何为他们写作，以及你希望将受众的思维引向何处。

3. 关注结果，而非过程

读者只需要足够的信息。提供足够有效的信息即可，不要包含任何可能让读者困惑或掩盖你核心信息的额外内容。

4. 讲述故事

故事能吸引受众，尤其是当它们植根于日常经验时。即使是提问，也能增加好奇心。然而，它们只在能带来价值的地方使用故事。

与我们的专家预约演示，深入了解 Baklib

预约演示

5. 指令要直接明确

对于开发者，或许用单字指令如“复制”、“删除”、“退出”就够了。然而，对于非技术受众，需要添加更多词汇——例如“按下删除按钮”。

6. 使用类比和示例

💛🧡🧡客户评价：Baklib 数字体验平台通过提供可扩展和可定制的解决方案来帮助我们，将其塑造成满足客户需求的 CMS。我们为客户提供工具来构建他们设想的网站，并使他们能够在将来轻松修改内容。

坚持使用常见的类比和现实世界的例子。当分享的经验与读者自身相距甚远时，他们往往会难以理解。

7. 在非技术人员中测试内容

请一位非技术背景的同事阅读你的文档，看看他们是否理解了你想要传达的信息。使用Baklib的AI工具等技术写作工具来优化你的内容。

8. 组织你的文档

信息的质量固然重要，文档的结构也同样关键。你不希望读者感到困惑。他们应该清楚下一步需要做什么。

9. 添加信息图等视觉辅助工具

在文档中添加视觉提示可以为非技术背景的受众简化技术信息。然而，如果文字解释已经足够清晰，就不要强行插入视觉元素。

10. 避免使用行话和过于复杂的术语

不需要解释每一个元素。例如，你的受众可能并不关心使用了哪种编程语言或者为优化做了哪些网格搜索。只聚焦于对传达核心信息至关重要的部分。

请记住，复杂的工作无法建立可信度和理解力。寻找方法，通过视觉元素和相关的体验让你的信息变得具体可感。或者，更好的做法是，从一个你的受众普遍面临、而你恰好有解决方案的问题开始讲起。

另请阅读： 视频在现代技术写作中的作用

观看 Dagle 的 Daria Tombolelli 分享如何为非技术用户简化文档。

结论

作为一名写作者，您的最终目标是以读者能够高效消化的方式向他们传递有效信息。无论您是为技术受众写作，还是像本文讨论的这样为非技术受众写作，这都无关紧要。重要的是您如何简洁地传达复杂的细节和信息。

然而，在为专家受众写作时，您可以自由使用技术语言和行话，但在为非技术受众写作时，则需要更加谨慎。

从您的措辞选择，到精简不必要的细节，再到简化信息，您的目标必须是传达需要传达的内容，同时不给读者造成负担。

• 优先考虑您的读者
• 减少术语和行话的使用
• 使复杂概念更易于理解
• 包含相关的示例、视觉元素和现实世界的类比
• 使用合适的技术写作工具测试和优化您的内容

最终，为技术受众成功进行技术写作的关键在于找到平衡点，为您的读者提供清晰且可操作的信息。

清除干扰，专注于他们需要了解的内容。

❓常见问题解答

如何为非技术受众写作？

没有人指望技术文档作者完全不使用技术词汇或概念。为非技术受众进行技术写作的期望，是以简化的方式解释产品、流程或程序，以便读者理解和使用信息。你需要做的是

● 调整你的写作风格

● 清晰地组织文档结构

● 添加视觉元素以辅助说明

在面向非技术受众写作时，同理心扮演什么角色？

同理心让你能够设身处地为读者着想。成为一名有同理心的作者，有助于你根据受众的需求定制内容。它让你能够以不同的视角看待你的受众，并有机会理解当你随意抛出技术类比和行话时，你的非技术受众会面临哪些挑战。

如何向非技术受众解释技术细节？

你可以从在文章中首次引入概念时就对其进行定义开始。如果可能，将其分解为易于理解的小步骤，这样你的受众就不会感到不知所措。为了更好地解释技术术语，可以使用类比、隐喻或日常生活中的例子。提供恰到好处的细节，因为细节过多或过少都可能导致困惑。专注于要点，并在需要时链接到其他资源。

视觉元素如何帮助为非技术受众进行技术写作？

我们人类往往比书面或口头内容更长时间地记住视觉内容。视觉提示可以帮助您

● 使信息更易于理解

● 简化复杂信息

● 保持读者的参与度。您可以包含图表、流程图、信息图、图像或图表，但要确保视觉提示流畅自然并为内容增值。

有哪些技巧可以帮助为非技术受众写作？

首先要把握好语调。它应该是友好且平易近人的，而不是枯燥或傲慢的。使用主动语态，创建更短的句子，并避免复杂的词汇。此外，人们喜欢故事、实时示例甚至案例研究。您可以加入一些幽默感，因为它能使内容更具人情味并保持读者的参与度。在开头使用它作为破冰手段，因为非技术受众可能会对技术写作感到畏惧。

通常为非技术受众撰写的文档类型有哪些？

通常为非技术受众撰写的文档包括

● 客户服务指南

● 使用说明

● 安装指南

● 产品描述

● 营销材料

● 社交媒体标题和帖子

● 新闻通讯

● 博客文章

● 新闻稿

● 分析和报告

● 网站内容

● 广告

● 培训材料

● 宣传册

● 常见问题解答

为非技术受众精心构建技术文档有多重要？

结构化的文档在提供信息和塑造用户体验方面起着至关重要的作用。一个结构清晰的文档易于导航和阅读，从而带来更好的用户体验。它也有助于降低支持成本，因为当信息被清晰地呈现时，用户可以毫不费力地据此行动。此外，它体现了专业性，有助于建立信任和可信度。

技术写作的AI工具如何帮助我为非技术受众创建有效内容？

在面向非技术受众进行写作时，技术写作的AI工具可以成为您宝贵的支持系统。除了简化复杂的技术语言外，技术写作工具还可以帮助您：
● 生成技术术语的定义
● 建议视觉输入
● 确保整个文档的一致性
● 构建文档结构
● 减少错误和编辑时间
● 提供实时反馈
● 迭代内容
● 增加参与度和可读性

对于非技术受众，最有效的报告方法是什么？

对于非技术受众，最有效的报告方法是优先考虑理解性，并避免涉及过多技术细节。
● 使用简单、清晰、简洁的语言
● 避免使用技术术语
● 用现实世界的例子解释复杂概念
● 添加视觉元素
● 专注于关键要点