专业与技术写作/说明
许多人习惯于遵循书面说明，但大多数人从未为其他人编写过说明。在许多专业角色中，您可能需要编写说明。虽然有些说明可能很简单，但其他说明可能更复杂，需要更长时间才能完成。因此，了解如何编写有用的说明非常重要。
编写有用的说明可能很困难，因为人们以不同的方式阅读和理解事物。例如，有些人是视觉学习者，可能难以遵循书面说明。读者也拥有不同的教育背景。在编写说明时，使用简单、逻辑的风格和格式很重要。
在编写说明时，避免使用说服性语言，并采用基于任务的方法。保持写作简洁明了，并专注于使用户成功完成任务。
一般来说，请遵循以下指南
简洁性和清晰性
保持句子简短易懂。尽可能使用常用术语。避免使用习语、俚语、行话、昵称、缩写和缩略语。如果您确实使用了可能陌生或令人困惑的术语，请在该术语首次出现在说明中时对其进行清楚定义。
受众
在编写说明时了解您的受众非常重要，这样您就可以包含所有必要的信息并排除不必要的信息。了解您的受众可以让您根据受众可能拥有的背景、经验和对主题的熟悉程度做出合理且明智的假设。例如，如果您正在为当地公共图书馆的一个老年人小组编写说明，那么假设他们熟悉打开特定软件应用程序的基本知识可能不安全。但是，如果您正在为专业组织内的一组软件开发人员编写说明，那么可以安全地假设他们熟悉打开特定软件应用程序的基本知识。
在决定将哪些信息包含在说明中以及排除哪些信息时，重要的是要明确识别您的受众是谁以及他们对说明主题和相关背景信息的熟悉程度和专业程度如何。
如果受众可能拥有广泛的经验和知识，包括不同程度的熟悉度和专业知识，您可以使用各种技术来保持每组说明简洁明了，并专注于一项单一任务，同时仍然提供必要的信息。例如，您可以为先决条件信息创建单独的说明，并为您的受众提供快速轻松地访问单独说明的方法（通过超链接、附录等）。
图形
一图胜千言。添加图形来传达您的想法可能比文字本身更有效。附有插图并伴随您的书面说明的说明通常非常成功。它增加了理解的额外层次，并允许读者在出现问题时进行快速浏览或故障排除。图片增加了额外的维度，可以让您的读者形象地看到最终产品。此外，在使用图形时，您应该注意那些视觉学习者，并调整图形。
虽然图片很棒，但您必须注意不要包含令人困惑或与实际书面说明无关的照片或插图。如果您将一张糟糕的图片与您的说明配对，您可能会在读者试图理解您的意思时造成压力或引入困惑。
此外，在拍摄照片时，请确保区域光线充足，照片清晰明亮。黑暗或模糊的照片通常难以理解。注意每次都以相同的方位拍摄主题，以避免混淆，并考虑使用三脚架。
在说明中使用图片时，大小也很重要。一张太小而无法看到的图片和一张模糊的图片一样无用。
为了强大且易于理解，您每个步骤的文本和图形应清楚地与说明的该步骤相关联。
格式
请记住，读者将在阅读说明的同时实际执行任务。因此，您不应使用密集的小块、难以辨认的文本。确保为您的说明页面创建一个设计和布局，以实现易读性并增加美学质量。保持页面简单，但具有明确的层次结构，将有助于读者完成说明步骤。
在设计页面时，坚实的层次结构对于扫描能力至关重要。使用粗体标题、斜体和罗马数字将帮助读者轻松找到自己的位置，并有助于整体视觉效果。
顺序
您的说明必须以逻辑顺序进行计划。确保在首页上清楚地说明问题。在您的问题之后，是一组详细说明如何解决所提问题的具体步骤。技术说明必须以逻辑模式流动。例如，在组装桌子时，如果您在所有螺丝都到位之前就进行最后的修饰，那将不是一件好事。如前所述，还应在必要时添加清晰的图形以说明操作。请记住，一图胜千言。
测试和验证
我们都知道编写说明很难，有时在纸上看起来不错，但当你真正尝试将说明付诸实践时，你可能会发现你的措辞对其他人毫无意义。请记住，对您来说可能是常见或显而易见的事情可能会让您的读者感到困惑，因此请了解您的受众。除了对自己进行说明测试之外，还要让一个对您的产品一无所知的人进行测试。这被称为可用性研究。记录有效和无效的内容，然后根据情况修改说明。从长远来看，测试说明的人越多，最终说明就越有效。
将您的说明定制为目标受众可能是您的写作过程中最困难的任务之一。在开始写作过程之前，您需要确定您的受众是谁，以及如何定制您的说明以使其尽可能易于理解。为了帮助您做到这一点，您可以问自己一些问题
- 您的受众成员可能有什么样的背景，他们可能拥有哪些先验知识？这将帮助您确定您需要在说明中包含哪些信息或不包含哪些信息。
- 他们的需求/兴趣是什么？
- 他们的统计数据将如何影响您的写作？如果您的受众大多数来自与您不同的统计数据，您需要考虑语言问题，并确保图形清晰。
- 您的受众是否有差异性？如果您的受众由具有不同背景的人组成，您的写作应针对大多数受众，您也可以考虑在附录中添加其他信息。
根据您对上述问题的答案，您可以通过多种方式确保您的说明对读者尽可能清晰。
- 添加读者为了理解您的说明而需要的信息（例如提示、旁注），并确保没有关键信息丢失。
- 不要添加不必要的信息；它可能会让您的读者感到困惑或误导。
- 确保文档符合您的受众水平。
- 添加示例/图形。图形对读者非常有用。
- 组织清晰。缺乏组织会造成混乱和沮丧。
以下部分描述了一组说明的一般结构的不同部分。要包含哪些部分将根据说明的复杂程度而有所不同。您的文档可能包含以下任何部分
- 简介
- 设备描述
- 必要的材料和设备
- 步骤
- 视觉辅助
- 故障排除
您在简介中包含的内容将取决于您的说明的用途以及谁将使用它们。在任何情况下，简介都应该简短，但仍然要有信息量。简介可以包含以下任何或所有部分
- 主题/目标：这里您应该指出将要解释的特定任务以及程序的结果是什么。
- 目标读者：您可能希望确定说明的目标读者是谁，以及读者是否需要额外的知识或背景才能完成任务。
- 范围：这将帮助读者了解说明是否能够帮助他们完成他们想要完成的任务。
- 组织：为读者提供对说明其余部分的概览可以帮助他们更容易地理解它们。本节也可以放在范围之下。
- 安全：您有责任告知读者在完成任务时可能发生的任何危险或危害。您需要以清晰易懂的方式显示警告。
如果读者必须使用设备来操作或维修设备，您可能需要包含设备的描述。
提供读者完成任务所需的设备清单，以便他们知道他们是否需要额外的工具或他们可能没有的物品。用品清单也有助于读者确保他们拥有所需的所有零件和部件。
本节显然是说明集中最重要的部分，因为它包含读者将遵循的实际步骤来完成手头的任务。有很多方法可以格式化步骤，但大多数使用编号列表。以下是您应该做的事情，以使步骤清晰简洁
- 用简洁的措辞编写每个步骤，以便它易于理解和完成。
- 技巧
- 为读者提供足够的信息来执行步骤，避免冗余。
- 将步骤放在一个列表中。编号通常效果最好。
- 突出显示关键词。
- 技巧
- 确保读者可以快速轻松地找到步骤。
- 技巧
- 给步骤编号。
- 在步骤之间跳行。
- 技巧
- 使操作在文本的其余部分中脱颖而出。
- 告诉读者如果他们犯了错误该怎么办。不知道该怎么办会导致沮丧，读者可能会放弃任务。
强烈建议使用图形和图片与每个步骤相对应。每个人都有不同的学习习惯；有些人喜欢文字，而另一些人则更喜欢图片。图形的存在也允许读者确保他/她仍在正确的轨道上。在大多数情况下，最好将图形和文字结合起来。
说明应该包含本节，告诉读者如果在构建过程中出现问题，或者完成的项目看起来不像预期的结果，该怎么办。将此信息放在表格格式中通常效果最好。
有关说明示例，请访问 [1] 此网页包含来自名为 Power Tools for Technical Communication 的教科书中的信息，作者是 David A. McMurrey。
可用性测试是在准备有效的一组说明中绝对至关重要的一步。完成说明草稿后，重要的是对其进行测试，看看在哪些方面可以改进。应该对每个更新说明草稿的多个测试人员进行可用性测试。以下是进行可用性测试的方法
1. 首先，您应该从代表您目标受众的群体中选择您的测试人员。为了挑选出这些特定用户，您可能需要提出一些初步问题。例如，询问他们对任务的经验水平或他们的工作领域。
2. 接下来，您需要选择如何评估测试人员在完成任务中的表现。有不同的方法可供选择，但其中一种方法称为“大声思考”方法。使用这种方法时，您会要求您的测试人员使用您的说明完成任务，并在他们浏览说明的过程中说出他们脑海中的所有想法。在测试人员进行测试时不要提供任何帮助，请礼貌地告诉他们您可以在测试结束后回答他们的问题。当测试人员说出哪些地方令人困惑或困难时，请做笔记。您可以将这些信息记录在一个有三个列的图表中。在第一列中，您将记录您的测试人员遇到的问题。在第二列中，您写下每个问题可能的原因。在第三列中，尝试为问题生成可能的解决方案，或者您可能改变说明以使其更易于理解的方法。确保您要找出的描述性内容。确保设计好测试表格以收集所有与测试相关的资料，以便不会遗漏或放错任何资料。
3. 测试结束后，查看您的笔记并请测试人员详细说明您记录的问题。这是重要的一步，因为您正在从您的受众那里获得直接反馈。确保您完全理解哪些地方让他们感到困惑，因为这将帮助您编写最成功的说明。询问测试人员您如何在说明的哪些步骤或部分进行更改以使其变得明确。
4. 根据您的发现，编辑和更新您的说明。这样做之后，它们应该更容易理解，并且更容易让您的目标受众遵循。在许多情况下，在完善您的说明时进行一轮或多轮可用性测试是适当的，甚至是有必要的。更多的测试可能在发现第一轮测试中被忽视的问题或由于最初的复杂情况掩盖了问题方面被证明是有益的。如果时间允许，请确保运行尽可能多的可用性测试轮次。
- 注意：请特别注意您的目标受众，并确保您拥有代表您的样本所需的测试人员数量和准确的人口统计信息。例如，如果您要为“初学者受众”制作说明，并且测试了“专家”受众，那么您的样本就不会具有代表性。此外，如果您想为一个包含多个年龄、性别和经验水平的大受众制作说明，那么您的样本需要很大，并代表该人群。
- 如果说明要求测试人员使用双手（例如系领带），请考虑使所有说明在不翻页的情况下可见，以便他们更容易完成任务。
许多人抵制阅读说明。他们试图自己弄清楚如何操作产品或执行任务，只有在所有努力都失败后才会求助于说明。当他们确实阅读说明时，他们希望立即理解所有内容，而不必阅读两次。简单的设计、朴素的措辞和清晰的说明对于鼓励读者关注您的说明或程序至关重要。
在编写技术文档和说明时，您应该牢记一些风格提示
- 使用大量祈使句、命令句或直接称呼式写作。在编写说明时使用“您”是可以的，因为您是在直接与读者交谈。
- 使用主动语态而不是被动语态。
- 不要遗漏冠词，如 a、an 和 the。
- 使用动作动词。
- 确保图形与描述性文字相匹配，以避免混淆。
- 用步骤标记图形，例如步骤 17 “…放…”，图形应该清楚地标记为数字“17”，或者如果一行文字存在多个图形，则按时间顺序写“17a、17b 等”，或者如果存在不同的视图，则写“17 正面、17 背面等”。
- 保持文本简短但描述性。
- 避免复杂的术语，使用简单的措辞来确保广泛的用户群体能够理解。
- 使用简洁的标题和副标题来描述和突出显示每个部分。
- 在标题周围留出足够的空白。
- 突出显示安全信息和警告。
- 保持插图尽可能简单。