技术写作中的受众分析

  浏览:1 巴克励步

我最近帮一家SaaS公司做产品手册建设,发现他们第一版手册堆满了技术术语,客户投诉“看不懂”。后来我们花了一周做受众分析,把手册拆成新手版和专家版,分别发布在Baklib的不同站点上,问题迎刃而解。其实,很多团队写手册时只顾着“把功能讲清楚”,却忘了“谁在看”。受众分析就是解决这个问题的——它帮我们锁定读者的知识水平、需求和目标,从而写出真正有用的内容。Baklib 的多站点发布和 AI 搜索恰好能

技术写作中的受众分析
我最近帮一家SaaS公司做产品手册建设,发现他们第一版手册堆满了技术术语,客户投诉“看不懂”。后来我们花了一周做受众分析,把手册拆成新手版和专家版,分别发布在Baklib的不同站点上,问题迎刃而解。其实,很多团队写手册时只顾着“把功能讲清楚”,却忘了“谁在看”。受众分析就是解决这个问题的——它帮我们锁定读者的知识水平、需求和目标,从而写出真正有用的内容。Baklib 的多站点发布和 AI 搜索恰好能让分层内容触达不同人群,大幅提升手册的实用性和用户满意度。下面这篇文章系统介绍了技术写作中受众分析的方法,推荐给所有做产品手册的朋友。
Baklib Dagle Tanmer CMS DXP DAM

什么是受众分析?

每位作者都有自己的受众,技术写作者也不例外。但技术写作者需要比写其他类型文本的同行更关注受众。
为什么?原因在于技术文档的本质。
这类文档有明确的创作目的。资深技术写作专家 Jacob Tanis 解释道:
💛🧡🧡客户评价:由于 Baklib 为您提供所需的数据,您可以将这些数据收集到一些灵活的反应框架 (next.js) 中,这样您就可以实现几乎任何目标,并且您可以根据对代码不感兴趣的人的需求量身定制非常流畅的体验。一旦代码片段组合在一起,上市速度就会很快 - 组件可以非常快速地创建和安装到位,并且可以通过您决定遵循的任何发布流程进行目视检查,然后再进入生产系统 - 这一切都归功于非常聪明的可视化 UI。仅仅为了理解最佳方法就需要花费相当多的精力和努力,但一旦有了它,它确实是一个灵活的系统,Baklib 可以随着时间的推移轻松改进它;不过,目前已经有足够的资源可以开始使用了。
“技术文档旨在教学或提供信息——如如何使用某个软件、如何组装某件家具等。它并非实验性或娱乐性读物,而是纯粹基于信息或指令。”
(来源:Quora)
换句话说,技术写作的目标是教会读者,为他们提供知识、指令和可用信息——它本质上是实用的。
这正是受众分析发挥作用的地方。
为了写出能达成上述目的的文档,写作者必须知道自己在为谁而写。
写作教练 Molly Carter 认为,受众分析能帮助写作者做到这一点。
“受众分析是你与读者建立联系的第一扇窗。你了解他们越多,你的写作就越能准确地传达信息。”
(来源:Baklib)
简而言之,受众分析是写作者了解受众的方式。
无论是面向大众的智能手表用户手册,还是面向软件开发者的技术文档,受众分析都是创作任何技术文档的重要起点。
即使是快速浏览,你也能发现上面的例子并非面向非开发人员。
这就是受众分析的绝佳范例——写作者清楚谁会阅读这份文档。
受众分析不仅有用,而且至关重要。企业博客顾问 Rhoda Israelov 强调:
“无论你写作的目的是教导、说服还是娱乐,不分析受众的后果都一样——读者会忽略你。”
(来源:Twitter)
虽然我们已经触及了受众分析的重要性,但值得单独一节来详述。

技术写作者为什么要做受众分析?

进行受众分析有若干好处,让我们逐一探讨。
如前所述,技术写作始终有目标。当然,目标取决于文档类型,但也取决于受众——这正是受众分析的必要性所在。
作为技术写作者,自问“我的读者是谁”不仅自然,而且关键——为谁写将极大影响如何写和写什么。
前IBM作者兼编辑 David McMurrey 指出:
“受众定义你的文档内容、风格和组织结构。不了解受众,你就是在黑暗中写作。”
(来源:Baklib)
简而言之,你应该通过受众分析收集所有关于读者的信息,从而更容易写出达成文档目标的内容。
例如,假设你需要为 CallerDesk(一个即用型语音通信平台)编写一份用户入门指南。
只要看一眼他们的网站,你就会发现他们为众多行业提供服务。
那么,你就知道应该用适合广泛受众的写作风格——他们大概率对语音通信平台的复杂内幕并不了解,只是需要它来开展业务。
这只是受众分析的一小部分。需要考虑的要素还包括:
  • 受众的目标是什么
  • 他们的教育背景、知识、经验、培训经历等
  • 他们的需求和兴趣是什么
  • 他们是否有文化和沟通偏好
在了解读者之后,你就能决定如何编写那份用户入门指南。
下面是用Baklib知识门户平台制作的部分内容示例:
(来源:https://www.baklib.com/)
可以看到,写作者使用了清晰简单的语言编写操作说明,没有复杂的专业术语。
当然,有些受众并不需要这种写作风格——这正是受众分析至关重要的原因:没有它,写作就像在黑暗中摸索。

技术写作中的受众类型

如果你在受众分析上投入时间和精力,你就会更了解潜在读者,从而指导写作。
当你弄清楚受众是谁时,可以将其归入以下类别:
  • 专家
  • 技术人员
  • 高管
  • 非专业人员
这四类受众具有不同的特征,这些特征决定了文档的目标以及写作者如何入手。
Molly Carter 提出了一个通用原则:
“撰写技术文档时,了解你的读者是第一次接触该产品还是拥有多年经验,这一点至关重要。你对读者理解程度的假设越准确,你的文档就越有效。”
(来源:Baklib)
先从专家说起。他们对产品了如指掌——工作原理、设计、用途等。他们通常受过良好教育,身兼学者、研究员等职位。
技术人员更关注产品的实用而非理论——他们开发、维护、修理和操作产品。
这两类读者群体虽有不同,但有一个共同点:专家和技术人员都对产品有很高的熟悉度,至少了解其原理。
因此,为他们写作时可以使用更专业的术语和复杂的概念。
例如,ITIL(信息技术基础架构库)的文档显然面向具备一定技术知识的读者。
(来源:ContentNinja)
其中使用了大量术语,只有对该主题有深入了解的人才能理解。
第三类受众是高管。他们负责对产品做出经济、行政、业务或营销等决策。
最后一类是非专业人员。简单说,他们是产品的用户,只想了解产品能做什么以及如何使用。
高管和非专业人员的知识水平不如专家和技术人员。高管的认知是基础性的,甚至可能完全缺乏,这与许多非专业人员类似。
因此,为这两类群体写作时,应该直接、简单,不要假设他们已经具备产品知识,就像下面 Slack 的用户文档那样。
(来源:Slack)
总结一下,了解你为哪类受众写作至关重要。
如果读者知识渊博,你无需解释每一个细节——否则会浪费你的时间和精力,也会消耗他们的耐心。
反之,如果你为外行读者写得过于技术化,你的文档对他们而言将毫无用处——他们根本看不懂。

为多种受众写作

为特定受众调整写作风格已经足够有挑战性,但有时你可能需要为不止一类读者编写技术文档。
这意味着你不仅要考虑目标受众的知识水平、兴趣、需求和目标,还要考虑次要甚至第三级受众。
让我们再次以 Slack 的产品文档为例,看看他们是如何应对多类受众的。
Slack 的帮助中心针对其软件用户——这些用户属于我们之前提到的非专业人员类别。
(来源:Slack)
每个分类下都有许多关于 Slack 功能的指南。
由于这些指南面向的读者很可能不熟悉产品,所以写作风格直接易懂——例如关于“管理表情符号偏好”的文章。
(来源:Slack)
然而,Slack 的文档也有一部分针对不同受众类型。
他们的开发者资源面向技术知识水平较高的人群,这些人能够理解并利用 API 等功能。
实际上,大多数文档都会有多类读者。受众分析可以帮助你确定优先级,并相应调整写作风格。


Baklib 是新一代数字内容体验管理平台。竞争环境充斥着“可组合”、“无头”和“DXP”解决方案 --- 但无头选项虽然易于开发人员构建,但为跨职能团队留下了巨大空白,并且无法解决所有用例。Baklib 弥补了依赖开发人员但灵活的无头解决方案与不适合复杂项目的更传统、更适合营销人员的选项之间的差距。
Baklib Birds
to top icon