- 本章以及《技术写作》教材的其余部分，重点关注技术写作技能。此处提供的技术内容不保证成功、准确或为最新版本。
- 本章使用 openai chatgpt 翻译。如发现任何语言问题，请发送邮件至 admin@mcmassociates.io。
- 本页图片中的文字将尽快翻译。
请点击此处以提供帮助 大卫 麦克默里 支付网站托管费用:
捐出你能提供的任何小额 !
在线技术写作将继续免费.
技术文档的受众—或任何写作作品—是预期或潜在的读者。对于大多数技术写作者来说，这是 最重要的 在规划、撰写和审阅文档时的考虑。 你 "adapt" 你的写作以满足将要阅读你作品的读者的需求、兴趣和背景。
备注：
- 在你阅读完关于受众的章节后，尝试使用 受众策划师. 你在空白处填写有关受众的详细问题的答案，然后通过电子邮件把它发送给自己，并可选择发送给你的教师。
- 此外，本章还包括一节关于 情况. 尝试使用该 情景 规划器 去了解你的受众所处的情况.
分析受众时要做的首要事情之一是识别其类型（或多种类型——很少只有一种）。对受众的常见分类如下：
- 专家： 这些人对理论和产品了如指掌. 他们设计了它, 他们测试了它, 他们对它的一切了然于心. 通常, 他们拥有高等学位并在学术界或在政府和科技领域的研发部门工作. 非专业读者最不可能理解这些人所说—但也最没有理由去尝试. 更常见的是, 专家面临的沟通挑战是如何与技术人员和管理层交流.
- 技术人员： 这些人是建造, 操作, 维护, 和修理那些由专家设计并进行理论研究的事物的人。 他们也具备高度的技术知识, 但更偏重实践。
- 高管: 这些人负责对专家和技术人员所处理的事务作出商业、经济、行政、法律、政府和政治方面的决策。如果是新产品，他们决定是否生产并推向市场。如果是新的电力技术，他们决定该市是否应当实施它。高管很可能与非专业人士一样缺乏关于该主题的技术知识。
- 非专业人士: 这些读者的技术知识是最少的. 他们的兴趣可能像技术人员一样务实, 但方式不同. 他们想了解新的电力技术, 足以在即将举行的债券投票中决定支持还是反对. 或者, 他们也可能只是对某个具体的技术问题感到好奇, 想了解它—但没有任何具体的、实用的理由.
受众分析
确定你的文档的潜在读者属于刚才讨论的四类中的哪一类很重要，但这还不是全部。无论属于哪一类，都必须从下列特征来分析受众：
- 背景—知识、经验、培训：
- 需求和兴趣： 要规划你的文档，你需要知道你的受众会对该文档抱有什么期望。设想读者将如何使用你的文档；他们会对它有什么要求。 例如，想象你正在编写一本关于如何使用新智能手机的手册—你的读者期望在其中找到什么内容？想象你与一家全国房地产协会签订合同，为其撰写一份关于全球变暖的背景报告—他们想读到什么；并且，同样重要的是，他们还想要什么 不 想阅读关于什么？
- 不同文化： 如果您为国际读者撰写，请注意用于表示时间和日期、货币金额和数字数量的格式在全球各地有所不同。还要注意，幽默和比喻性语言（例如 "hit a home run"）在我们自己的文化之外可能不会被理解。德克萨斯农工大学提供 第6章, "为国际读者写作," 的 报告技术信息, Elizabeth Tebeaux, 等。 有关标准，请参见 风格指南列表 来自维基百科。 (感谢那位贡献这些重要想法的匿名访客。)
- 其他人口特征： 当然，你的读者还有许多其他特征 可能 会影响你应该如何设计和撰写你的文档—例如，年龄组、居住类型、居住地区、性别、政治偏好等。
受众分析可能会因至少两个其他因素而变得复杂：同一文档的混合受众类型, 受众内部差异大, 以及未知受众.
- 不止一个受众。
- 观众差异很大。 你可能会意识到，尽管你的受众只属于一个类别，但他们的背景差异很大。 这是一个棘手的问题—如果你按最低共同水准为读者写作，你很可能会写成一本笨重、乏味的书，从而令大多数读者反感。但如果你不按那个最低水平写作，你就会失去那部分读者。怎么办？大多数作者会迎合大多数读者，牺牲那些需要更多帮助的少数人。其他人则把补充信息放在附录中，或加入指向初学者书籍的交叉引用。
受众-分析 示例
如果你正在参加技术写作课程, 你可能需要在你的技术文档中附加受众描述. 下面是一个示例:
| 给讲师的说明： 本说明适用于希望通过在 Microsoft Excel 中使用宏来简化计算并高效处理数据的人员。他们了解如何将数据输入 Microsoft Excel，并具备 Microsoft Office 套件的基础知识。他们熟悉使用 Windows 软件，并具备基本的算术能力以验证计算结果并检查计算中的逻辑错误。 |
受众适应
好！所以你已经分析了你的受众，直到比你了解自己还要了解他们。有什么用？你如何利用这些信息？你如何避免写出对读者仍然难以理解或毫无用处的内容？
写作的生意 到 与你的受众建立联系可能在很大程度上依赖与生俱来的天赋、直觉，甚至某种神秘感。但有一些可供你使用的控制手段，可以提高你与读者建立联系的机会。以下 "controls" 大多与让非专业受众更容易理解技术性信息有关：
- 添加读者理解您的文档所需的信息。 关于内容的想法 有关详情。)
- 省略读者不需要的信息。 不必要的信息也会让读者感到困惑和沮丧—毕竟，它在那里会让他们觉得有义务去阅读。比如，你可以把理论性的讨论从基本说明中删掉。
- 更改你当前拥有的信息级别. 你可能掌握了正确的信息，但它可能 "pitched" 在技术水平上定得过高或过低。它可能面向错误类型的受众—例如，面向专家而不是技术人员。当将产品设计说明当作操作指示发布时，这种情况最常发生。
- 添加示例以帮助读者理解。 示例是与受众建立联系的最有力方式之一, 特别是在教学中. 即使在非教学性文本中, 例如当你试图解释一个技术概念时, 示例也是很有帮助—尤其是类比.
- 更改你的示例级别。 你可能在使用示例, 但技术内容或水平可能不适合你的读者. 通俗的示例可能对专家没有帮助; 过于技术性的示例可能完全无法让你的非专业读者理解.
- 更改你的信息的组织方式。 有时候，你可能掌握所有正确的信息，但排列方式不当。例如，开头的背景信息可能太多（或太少），以致某些读者迷失。有时候，背景信息需要合并到主要信息中—例如，在说明中，有时更好在需要时把背景信息分块加入。 (参见关于 结构 和 组织 文档中的信息.)
- 加强过渡。 读者，尤其是非专业读者，可能很难看出你文档主要部分之间、各段落之间，有时甚至各句子之间的联系。你可以通过添加 过渡词 并通过回显 关键词 不 过渡.)
- 撰写更有力的引言—既适用于整篇文档，也适用于主要章节. 介绍 既适用于整份报告，也适用于报告内的各个部分.)
- 为段落和段落组创建主题句。 使用概述和主题句.)
- 改变句子的风格和长度。 是 动词措辞。所有这些使你的写作更直接、更有临场感—读者不必费力去寻找它。 (参见关于 常见的句子风格问题 有关详细信息。)
显然, 句子长度也很重要. 平均每句大约在15到25个单词之间比较合适; 超过30个单词的句子应当被怀疑. - 努力提高句子的清晰度和简洁性. 常见的句子风格和清晰度问题 有关详细信息.)
- 使用更多或不同的图形. 图形 详情请参阅。)
- 将文本拆分或合并为有意义、可用的块. 对于非专业读者, 你可能需要使用更短的段落. 也许一个6到8行的段落通常是上限. 注意为专家撰写的技术文档中的段落要长得多.
- 为重要信息添加交叉引用。 在技术信息中, 你可以通过指引他们查阅背景资料来帮助非专业读者. 如果你不能当场对某个主题做出全面解释, 就指出包含该内容的节或章. (参见有关章节 交叉引用 详情请见.)
- 使用标题和列表。 读者可能会被那些又大又密集的段落吓到，这些段落除了偶尔的空行外没有其他分隔。 在你的草稿中寻找加入标题的方法—注意主题或子主题的变化。 在你的文章中查找事物的列举—这些可以做成纵向列表。 寻找成对的列举，例如术语及其定义—这些可以做成两栏列表。 当然，要小心不要强行使用这种特殊格式—不要过度使用。 (参见有关 标题 和 列表 有关详细信息.)
- 使用特殊排版, 并调整边距, 行宽, 行间距, 字号, 和字体样式. 对于非专业读者, 你可以做一些事情, 比如让行更短 (缩小页边距), 使用更大的字号, 以及其他类似的策略. 某些字体样式被认为比其他样式更友好、更易读. (试着找一位从事出版的人, 向他们请教一些关于字体的见解.)
情况分析 & 发明
仅仅挑选一个主题并为技术写作项目确定受众是不够的。你需要知道 (或发明) 那个 情况 在该受众所处的环境中—它的目标是什么: 解决问题、促进改进、支持决策? 为技术文档撰写的情境可能像人类社会关系一样无穷无尽。一个技术文档情境涉及一个受众，需要或请求某种类型的技术文档以满足其特定需求和用途。详情请参见 情境分析 & 发明
相关信息
通过调查发掘受众洞察. BrightTalk
观众. 北卡罗来纳大学教堂山分校
我会很感激你对本章的想法、反应和批评： 你的回应—大卫 麦克默里
