跳转至内容

专业和技术写作/设计

来自维基教科书,开放世界中的开放书籍
专业和技术写作
商务沟通 设计 报告

设计文档

[编辑 | 编辑源代码]

安德森第 11 章:“编写以读者为中心的首页和附录”

[编辑 | 编辑源代码]
  • 在您的职业生涯中,您将努力在公司中取得成功并晋升。还有什么比创建与众不同的文档更能留下深刻印象呢?使用传真信、封面以及首页和附录将提高文档的可使用性和说服力。了解如何以及何时使用这些工具来取得成功是一项习得技能,但随着实践,掌握这种能力将带来回报!
  • 根据**保罗·V·安德森的著作《技术传播:以读者为中心的方法》**,有多种方法可以提高文档的可使用性和说服力。首先是要弄清楚如何**帮助受众找到他们需要的东西**。尤其是在技术文档中,让读者轻松找到他们确切需要的东西至关重要。技术文档通常很长,因此文档的必要部分应该是**目录**和**索引**。这两个项目通常分别位于文档的开头和结尾,允许读者快速找到他们正在查询的内容。另一个应该考虑的事情是使您的文档易于浏览,那就是**标题**本身。准确的标题将允许读者在相关主题堆栈中轻松快速地找到您的文档。
  • 安德森的著作解释了如何通过包含文档主要要点摘要来增强您的文档。它被称为**摘要**或**管理摘要**。在您的文档主要要点中包含其中一个摘要在商业世界中至关重要。被称为**管理摘要**的摘要实际上是指给管理人员(很可能您的老板)的摘要。这个摘要是管理人员首先会看的东西。您的文档的决策者通常是非常忙碌的人,他们需要一个摘要来了解您要展示什么。管理摘要需要包含整个报告信息的简要摘要。最重要的基本信息放在这里。关于摘要部分的一个提示是给您的受众留下良好的第一印象。我敢保证,如果您的老板翻到管理摘要却发现它不存在,您不会给他们的留下良好的印象。
  • 其他增强读者印象的方法包括**创建吸引人的标题**以及仔细选择最具吸引力的字体。创建您的文档,使其创造这种良好的第一印象,是创建与众不同的文档最重要的方面。人脑在意识到我们的决定之前,会对所有类型的刺激做出判断。我们甚至不知道,人脑在我们可以开始理性思考并试图做出明智的选择之前就已经做出了选择。基于此知识,吸引人的封面和设计选择确实可以对您的文档的成功产生重大影响。合适的颜色、字体和封面的风格可以决定一切。
  • 另一个与设计方面相一致的提示是正确**组织您的文档**。设计良好且组织良好的文档通常在公司中使用更长的时间,因为它的有用性,未来的员工将能够反复使用您的高质量文档。商务文档的设计元素不容忽视。拥有高质量的设计不仅可以让您的文档看起来更好,还可以改变受众的看法。根据您组织文档布局的方式,可以改变人们对文档内容的看法。良好的设计会使您的文档看起来更专业,从而提高文档的可信度。良好的设计还可以引导您的受众获得您希望他们从文档中学习的内容。根据您选择合并的字体和样式,您可以让某些要点脱颖而出。
  • 专业文档的设计可以说服受众阅读它,但为了让实际的文档说服您的受众,您必须首先**以受众为中心进行写作**。安德森的著作告诉我们,“通过彻底了解读者的目标、价值观和态度,您可以确定在管理摘要中应该包含和强调哪些内容,以引导读者做出您倡导的决定或采取您倡导的行动(第 307 页)”。读者只需要阅读管理摘要就能了解您的文档的要点。以这种方式引导读者在可行性研究中尤为重要。可行性研究是为了找出解决方案是否可行而进行的。因此,向您的受众传达一致的信息非常重要。作为作者,您比任何人都更了解主题内容,因此您必须让读者了解可行性研究的重要信息。如果您没有传达重要信息,您的研究将缺乏影响力。


  • 记住:**外观很重要!**无论是使用照片、您喜欢的字体、图表来解释您的数据发现,还是像页码和标题这样的简单元素,文档的视觉外观和演示都非常重要,应该小心处理。在任何环境下撰写商务文档时,都需要一份专业的外观文档来传达文档的信息。通过适当的组织和设计元素的适当使用,文档不仅在内容方面,而且在视觉吸引力方面也能言简意赅。

常见的排版和设计元素

[编辑 | 编辑源代码]
  • 在撰写专业风格的文档时,使用经典的**衬线字体**。**衬线字体**的示例包括 Times New Roman、Garamond 和 Baskerville。这些字体样式最常使用,因为它们最适合大段文字的可读性,并为文档增添了令人敬畏的专业性。这些字体具有明显的线条,这意味着每个字母的主要部分清晰可见。
  • 使用斜体等样式可以帮助强调,但过度使用它们会导致文本变得难以阅读。尽量不要一次使用超过一个句子的斜体。
  • 大写字母也很适合强调,但一次不要使用超过几个单词。大写字母形状之间的相似性使它们在长时间阅读时难以识别。

标题和副标题

[编辑 | 编辑源代码]
  • 使用适当的**标题和副标题**。这些对读者在浏览文档时非常有用。它们将文档的各个部分分开,并提供文档中提供的信息的基本纲要。标题应与正文文本区分开来,以确保读者能够清楚地识别一个部分何时开始或结束。**无衬线字体**(Arial、Franklin Gothic、Myriad、Helvetica 和 Gill Sans)最适合,因为它易于阅读,并且可以视觉上将标题与正文文本分开。这些字体应为粗体且略微更大,以清楚地区分标题。区分标题和副标题的一种更简单的方法是使用字处理软件中已格式化的标题,它还可以从文档中合并的标题/副标题创建目录。

页眉和页脚

[编辑 | 编辑源代码]
  • 页眉和页脚用于大型文档,帮助读者在阅读文本时进行导航。页眉可以用来通过重新陈述章节或所选内容所在的页面来区分不同的章节。页眉还可以增强文档的整体一致性。页眉的常见用法是将作品标题放在每一页,以及自动生成页码。这可以确保读者理解文档应作为整体进行阅读,或在文档阅读过程中页面被拆分时对文本页面进行整理。页脚也可以包含有用的信息。页脚还可以包含页码或脚注,用来描述文本中可能让读者感到困惑的某些方面,需要进一步说明。脚注的另一个用法是在每页允许读者更容易地阅读引用和补充信息,而不是将脚注放在文档的末尾。页码有助于导航,并赋予目录意义。

视觉效果的使用

[编辑 | 编辑源代码]
  • 视觉效果可以在各种商业和职业文档中使用。在{图表和图形}和{照片和插图}中进行了详细的解释,视觉辅助的使用可以为文档增加质量和趣味性。图表和图形用作补充信息,以视觉形式解释数据或某些信息材料,而照片和插图则更常被用作补充信息,以视觉形式增强读者对内容的理解。如果使用得当,这些视觉辅助可以为文档增添专业性,使其阅读起来更令人愉悦。务必注意视觉效果在文档正文中的位置。

注意:应将图像放置在文本中的自然断点处。在段落或章节之间是最常见的。这样,图像不会中断阅读流程,也不会使读者对文档接下来的内容感到困惑。请确保使用逻辑位置,以确保图像补充其附近或周围的文本。

线条元素和颜色

[编辑 | 编辑源代码]
  • 线条元素和颜色是另外两种不太常用于正式书面文档的元素。一般来说,文本保持黑色在白色背景上。这种书写文档的标准最易于阅读,允许信息成功呈现,并防止复杂的视觉效果或其他干扰因素分散注意力。写作时可以使用颜色,但在专业文档中应谨慎而细致地使用。通常,徽标或标题将使用颜色来区分自己与正文。在标题中,颜色一般为蓝色红色绿色,以吸引注意而不分散读者注意力。徽标保持较小,放置在文档的右上角或页脚处。文本与徽标或线条混合使用的情况并不常见。而正文中的彩色文字会使阅读变得极其困难。可以使用线条来分隔章节或区分页眉和页脚。这些线条应细且颜色浅,以匹配文本,并且不会给文档带来不必要的视觉重量。

当这些元素使用得当且得体时,它们会为文档增添趣味和专业性。使用视觉效果和组织元素补充信息有助于引导读者浏览文档。


快速提示

[编辑 | 编辑源代码]
  1. 保持信息简洁。
  2. 使用简短的段落。
  3. 使用主题行指定你的信息。
  4. 使用标题标识信息的各个部分。
  5. 避免使用分散注意力的颜色和背景。

主页

华夏公益教科书