请点击这里以获取帮助 大卫·麦默里 支付网站托管费用:
捐赠任何您能的小额款项!
在线技术写作将保持免费。

技术文档的观众—或任何写作作品的观众—是预期的或潜在的读者。对于大多数技术写作者来说,这就是 最重要的 在规划、写作和审阅文档时的考虑。你需要"调整"你的写作,以满足将要阅读你写作的读者的需求、兴趣和背景。

这个原则似乎既简单又明显。它就像告诉某人,"说话时要让你面前的人能够理解你在说什么。"就像说,"不要对你六岁的孩子讲火箭科学。"我们需要上这个课程吗?似乎不需要。但事实上,缺乏对受众的分析和适应是你在专业技术文档中发现的大多数问题的根本原因之一—特别是在说明书中,这一点表现得最为明显。

笔记:

NotebookLLM-generated infographic of this chapter

观众类型

分析受众时要做的第一件事之一是确定其类型(或类型—通常不止一种类型)。受众的常见分类如下:

受众分析

重要的是确定您的文档潜在读者属于刚才讨论的四个类别中的哪一类,但这并不是全部。不论类别如何,对受众的分析还必须考虑以下特征:

受众分析可能会因至少两个其他因素而变得复杂:一个文档中混合受众类型、受众内的广泛差异,以及未知受众。

受众分析示例

如果您正在参加技术写作课程,您可能需要在技术文档中附加受众描述。以下是一个示例:

致教师的备注: 这些说明旨在为希望通过使用宏来高效计算数据的个人提供指导,以简化他们在 Microsoft Excel 中的计算。他们了解如何将数据输入到 Microsoft Excel,并对 Microsoft Office 套件有基本的了解。他们能够熟练使用 Windows 软件,并具备基本的算术能力,以验证计算结果并检查计算中的逻辑错误。

观众适应性

好的!所以你已经分析了你的受众,直到你对他们的了解超过了对自己的了解。这有什么用呢?你如何利用这些信息?你如何避免写出对读者来说仍然无法理解或无用的东西?

写作的事务 你的听众可能与天生的才能、直觉甚至神秘感有很大关系。但你可以使用一些控制手段来更好地与你的读者建立联系。以下"控制"主要是为了让技术信息对非专业受众更易于理解:

这些是专业技术写作者用来微调他们工作的"控制",使其尽可能易于理解的那种方法。与此相对的是,这些领域中许多问题的积累—即使看似微不足道的—也会导致文档难以阅读和理解。 非专业人士常常质疑为什么专业作家和编辑坚持处理写作中如此看似挑剔、琐碎、小气的细节—但这些细节都累积起来了!这让我想起古代中国的一种处决方法叫做"千刀万剐。"然而,在这种情况下,它将是"因千个小问题而困惑。"

情境分析与创造

仅仅选择一个主题并定义一个受众对于技术写作项目来说是不够的。你需要了解(或创造)这个 情况 在这个受众运作的领域—其目标是什么:解决问题、促进改进、支持决策?技术文档写作的情况可能与人类社会关系一样无穷无尽。技术文档情境涉及一个受众,因其特定需求和用途,正在需要或请求某种类型的技术文档。有关详细信息,请参见 情况分析与发明


相关信息

使用调查揭示受众洞察. BrightTalk

观众北卡罗来纳大学教堂山分校

我会很感激你对这一章的想法、反应和批评: 你的回应大卫·麦默里