请点击这里以获取帮助 大卫·麦默里 支付网站托管费用:
捐赠任何您能的小额款项!
在线技术写作将保持免费。
技术文档的观众—或任何写作作品的观众—是预期的或潜在的读者。对于大多数技术写作者来说,这就是 最重要的 在规划、写作和审阅文档时的考虑。你需要"调整"你的写作,以满足将要阅读你写作的读者的需求、兴趣和背景。
这个原则似乎既简单又明显。它就像告诉某人,"说话时要让你面前的人能够理解你在说什么。"就像说,"不要对你六岁的孩子讲火箭科学。"我们需要上这个课程吗?似乎不需要。但事实上,缺乏对受众的分析和适应是你在专业技术文档中发现的大多数问题的根本原因之一—特别是在说明书中,这一点表现得最为明显。
笔记:
- 一旦您阅读了关于受众的部分,请尝试使用该 受众规划师. 您填写关于您的受众的详细问题的空白处,然后将其通过电子邮件发送给自己,您也可以选择发送给您的Instructor。
- 此外,本章包括一个关于 情况. 尝试使用 情境规划者 以便了解你的听众所处的情况。
分析受众时要做的第一件事之一是确定其类型(或类型—通常不止一种类型)。受众的常见分类如下:
- 专家: 这些人对理论和产品非常了解。他们设计了它,测试了它,了解一切。通常,他们拥有高级学位,在学术环境或政府和技术领域的研发部门工作。非专业读者最不可能理解这些人在说什么,但也缺乏动机去尝试。更常见的是,专家面临的沟通挑战是与技术人员和高管进行沟通。
- 技术人员: 这些人负责建造、操作、维护和修理专家们设计和理论化的东西。他们同样拥有高度专业的知识,但性质更为实用。
- 高管: 这些人负责做出关于专家和技术人员所处理的事务的商业、经济、行政、法律、政府和政治决策。如果是新产品,他们决定是否生产和推广。如果是新能源技术,他们决定城市是否应该实施。高管对这些主题的技术知识可能和非专业人士一样少。
- 非专业人士: 这些读者具备的技术知识是最少的。他们的兴趣可能与技术人员一样实用,但方式不同。他们想了解新电力技术,以便知道在即将到来的债券投票中是支持还是反对。或者,他们可能只是对某个特定的技术问题好奇,想要了解它——但并没有具体的实用原因。
受众分析
重要的是确定您的文档潜在读者属于刚才讨论的四个类别中的哪一类,但这并不是全部。不论类别如何,对受众的分析还必须考虑以下特征:
- 背景__实体_0__知识、经验、培训: 您最重要的关注点之一是您可以期望读者具备多少知识、经验或培训。如果您预计部分读者缺乏某些背景,您是会在文档中自动提供这些信息吗?考虑一个例子:假设您正在编写使用在 Microsoft Windows 下运行的软件产品的指南。您可以期待读者对 Windows 知道多少?如果有些人可能对 Windows 知之甚少,您应该提供这些信息吗?如果您说不,那您就面临客户对产品感到沮丧的风险。如果您说是的,增加关于 Windows 的背景信息,您就会增加工作量,并增加文档的页数(从而增加成本)。显然,这个问题没有简单的答案——部分答案可能涉及到受众中有多小的部分需要这些背景信息。
- 需求和兴趣: 为了规划您的文档,您需要了解读者对该文档的期待。想象一下读者将如何使用您的文档;他们会对其提出什么要求。例如,假设您正在撰写一份关于如何使用新智能手机的手册—您的读者期望在其中找到什么?再假设您受委托为一家国家房地产协会撰写关于全球变暖的背景报告—他们希望阅读哪些内容;同样重要的是,他们希望得到什么信息。 不 你想读些什么?
- 不同文化: 如果您为国际观众写作,请注意时间和日期、货币金额以及数字数量的表示格式在全球范围内各不相同。同时请注意,幽默和比喻语言(例如“击出全垒打”)在我们以外的文化中不太可能被理解。德克萨斯州农工大学提供了 第六章, "为国际读者写作," 的 报告技术信息,伊丽莎白·特比奥,等。有关标准,请参见 风格指南列表 来自维基百科。(感谢这位匿名访客贡献了这些重要的想法。)
- 其他人口特征: 当然,还有很多其他关于你读者的特征。 可能 对您如何设计和撰写您的文件—有影响,例如,年龄组、居住类型、居住区域、性别、政治倾向等等。
受众分析可能会因至少两个其他因素而变得复杂:一个文档中混合受众类型、受众内的广泛差异,以及未知受众。
- 多个观众。 你可能会发现你的文档面向多个受众。例如,它可能会被技术人员(专家和技术员)和管理人员(高管)所查看。该怎么办呢?你可以将所有部分都写得让你文档的所有受众都能理解(祝你好运!)。或者,你可以严格按照每个受众的兴趣来编写每个部分,然后使用标题和节介绍来提醒你的受众该去哪里,什么该避免。
- 观众的差异很大。 您可能意识到,尽管您的受众只属于一个类别,但他们的背景差异很大。这是一个棘手的问题—如果您写作时只考虑最低共同受众,您可能会得到一本笨重、乏味的书,这会让大多数读者失去兴趣。但如果您不考虑这个最低层次,您将失去那部分需要更多帮助的读者。该怎么办呢?大多数作家选择迎合大多数读者,牺牲了那部分需要更多帮助的少数读者。另一些人则将补充信息放在附录中,或者插入对初学者书籍的交叉引用。
受众分析示例
如果您正在参加技术写作课程,您可能需要在技术文档中附加受众描述。以下是一个示例:
| 致教师的备注: 这些说明旨在为希望通过使用宏来高效计算数据的个人提供指导,以简化他们在 Microsoft Excel 中的计算。他们了解如何将数据输入到 Microsoft Excel,并对 Microsoft Office 套件有基本的了解。他们能够熟练使用 Windows 软件,并具备基本的算术能力,以验证计算结果并检查计算中的逻辑错误。 |
观众适应性
好的!所以你已经分析了你的受众,直到你对他们的了解超过了对自己的了解。这有什么用呢?你如何利用这些信息?你如何避免写出对读者来说仍然无法理解或无用的东西?
写作的事务 到 你的听众可能与天生的才能、直觉甚至神秘感有很大关系。但你可以使用一些控制手段来更好地与你的读者建立联系。以下"控制"主要是为了让技术信息对非专业受众更易于理解:
- 添加读者理解您文档所需的信息。 检查是否缺少某些关键信息—例如,说明中的一系列关键步骤;有助于初学者理解主要讨论的重要背景;关键术语的定义。(见本章关于 内容创意 有关详情。)
- 省略读者不需要的信息。 不必要的信息也会让读者感到困惑和沮丧—毕竟,这些信息让他们感到有义务去阅读。例如,您可以从基本说明中删去理论讨论。
- 更改您当前所拥有的信息的级别。 您可能拥有正确的信息,但它可能在技术层面上"定位"得太高或太低。它可能针对错误类型的受众—,例如,面向专家受众而不是技术人员受众。当产品设计说明被当作说明书时,这种情况最常发生。
- 添加示例以帮助读者理解。 示例是与观众连接的最强大方式之一,尤其是在说明中。即使在非说明性文本中,例如,当你试图解释一个技术概念时,示例也是很大的帮助,特别是类比。
- 改变你的例子的难度。 您可能使用了示例,但技术内容或水平可能不适合您的读者。自编的示例对专家可能没有用;高度技术性的示例可能完全与您的非专业读者无关。
- 改变信息的组织方式。 有时,你可能拥有所有正确的信息,但以错误的方式排列它们。例如,开头可能有过多的背景信息(或过少),导致某些读者感到困惑。有时,需要将背景信息整合到主要信息中,例如,在说明中,有时在立即需要时提供背景信息的块会更好。(见章节) 结构 和 组织 文档中的信息。
- 加强过渡。 读者,特别是非专业人士,可能会难以看出您文档主要部分之间、单独段落之间,有时甚至是单独句子之间的联系。您可以通过添加来使这些联系更加清晰。 过渡词 并通过回声 关键词 更准确地说。像"因此," "例如," "然而"这样的词是过渡词—它们表明前一个想法与接下来想法之间的逻辑联系。通过仔细回响相同的关键词,您还可以加强过渡。在技术性写作中,这很重要。 不 变换用词是个好主意—使用相同的词,以免人们变得更加困惑。(参见章节) 过渡.)
- 为整个文档和主要部分撰写更强有力的引言。 人们在阅读时似乎更有信心和理解力,当他们有一个"大局"—对即将发生的事情的看法,以及它与他们刚刚阅读的内容的关系。因此,确保你对整个文档有一个强有力的引言—明确主题、目的、受众和该文档内容的引言。而对于文档中的每个主要部分,使用小引言,至少指明该部分的主题,并概述将要涵盖的子主题。(参见章节) 介绍 用于整个报告和报告中的部分。
- 为段落和段落组创建主题句。 这可以大大帮助读者,让他们了解一个部分(一组段落)的主题和目的,特别是为他们提供即将涉及的子主题的概述。当你处于不同的状态时,路线图会很有帮助! (请参阅该章关于) 使用概述和主题句.)
- 请改变句子的风格和长度。 您在个别句子层面上如何书写—也会产生很大差异。例如,在指示中,使用命令语气和"你"的表达方式比被动语态或第三人称表达方式更易于理解。出于某种原因,个性化您的写作风格,让其更轻松和非正式,可以使其更易于接触和理解。被动、无人的写作更难阅读—在您的写作中增加人物和动作。同样,选择主动动词而不是 是 动词措辞。所有这些使你的写作更加直接和即时—读者不必费力去寻找它。(参见这一章节关于 常见的句式问题 有关详细信息。)
显然,句子的长度也很重要。每个句子的平均字数在15到25个之间是比较合适的;超过30个字的句子应当受到怀疑。 - 提高句子的清晰度和简洁性。 这与之前的 "控制"紧密相关,但值得单独提及。通常,写作风格可能会非常冗长,以至于难以或令人沮丧地阅读。当你修改草稿时,要让它们“减肥”—逐行查看草稿,尽量将整体字数、页面或行数减少20%。试一下这个实验,看看你的效果。你会发现很多繁琐、不必要的细节和夸大的措辞可以删去。(参见关于 常见的句子风格和清晰度问题 有关详细信息。
- 使用更多或不同的图形。 对于非专业观众,您可能希望使用更多图形—而且要更简单。针对专业人士的图形更为详细,更具技术性。在面向非专业人士的技术文件中,通常还会有更多"装饰性"图形—这些图形很吸引人,但并没有严格的信息或说服目的。(请参见章节) 图形 有关详细信息。
- 将文本分割或整合成有意义、可用的块。 对于非专业读者,您可能需要使用较短的段落。通常6到8行的段落是常见的最大长度。注意,在为专业人士撰写的技术文档中,段落往往要长得多。
- 添加对重要信息的交叉引用。 在技术信息中,你可以通过指引非专业读者查阅背景资料来帮助他们。如果你无法当场全面解释一个主题,可以指向一个包含相关内容的章节或部分。(参见章节关于) 交叉引用 有关详情。
- 使用标题和列表。 读者可能会被密密麻麻的大段文字所吓到,偶尔才有一行空白来切分。检查你的初稿,寻找插入标题的方法—寻找主题或子主题的变化。检查你的写作中事物的列举—这些可以制作成垂直列表。寻找成对的列表,例如术语及其定义—这些可以制作成双栏列表。当然,要小心不要强迫使用这种特殊格式—不要过度使用。 (参见有关章节) 标题 和 列表 (详细信息。)
- 使用特殊排版并处理边距、行长度、行距、字体大小和字体样式。 对于非专业读者,可以采取一些措施,比如缩短行距(缩小边距)、使用更大的字体大小以及其他类似的方法。有些字体风格被认为比其他字体更友好和易读。(试着找一些与出版相关的人,获取关于字体的见解。)
这些是专业技术写作者用来微调他们工作的"控制",使其尽可能易于理解的那种方法。与此相对的是,这些领域中许多问题的积累—即使看似微不足道的—也会导致文档难以阅读和理解。 非专业人士常常质疑为什么专业作家和编辑坚持处理写作中如此看似挑剔、琐碎、小气的细节—但这些细节都累积起来了!这让我想起古代中国的一种处决方法叫做"千刀万剐。"然而,在这种情况下,它将是"因千个小问题而困惑。"
情境分析与创造
仅仅选择一个主题并定义一个受众对于技术写作项目来说是不够的。你需要了解(或创造)这个 情况 在这个受众运作的领域—其目标是什么:解决问题、促进改进、支持决策?技术文档写作的情况可能与人类社会关系一样无穷无尽。技术文档情境涉及一个受众,因其特定需求和用途,正在需要或请求某种类型的技术文档。有关详细信息,请参见 情况分析与发明
相关信息
使用调查揭示受众洞察. BrightTalk
观众北卡罗来纳大学教堂山分校
我会很感激你对这一章的想法、反应和批评: 你的回应—大卫·麦默里
