如何编写用户说明书

用户手册是文字版指南，它可以是纸质的或电子文档（PDF或XPS格式）的形式，内容为如何做某事或如何操作某物。虽然“用户手册”通常被认为是计算机软件指南，但用户手册也适用于电脑和其他电子设备，如电视、音响、电话系统、MP3播放器，以及家用电器、草坪和花园设备。好的用户手册有助于用户了解产品的特性，同时教他们如何有效地运用这些特性，而且排版可以方便阅读和查找。在编写有效的内容和设计用户手册的布局时，需要考虑以下事项。

方法 1

方法 1 的 3:

编写恰当的用户文档

下载PDF文件

1
弄清你的用户是谁。要编写一个成功的用户手册，你需要先研究用户概况，无论是正式地创建一个书面文件，还是非正式地方式，都要花时间分析用户的特点。这样的概要文件非常有用，不仅有助于团队编写用户文档，而且还有助于将产品本身从概念转换为成品。在构建用户概况时需要考虑的事项包括：
- 用户会在哪里使用用户指南，比如在家里、办公室、远程工作地点或汽车上。这不仅能决定用户手册的内容，还能决定要采用的样式。
- 用户如何使用用户指南。如果手册的使用频率低，用户只会偶尔翻看或查找信息，那就应该采取参考文件的形式。如果使用频率高，用户在一开始就得经常查阅，那么参考部分应该附带一个“入门”章节，并说明产品将用于哪些最常见的任务。
- 用户对该产品或其他类似产品有多少使用经验。如果你的产品是新产品或与同类产品有很大差别，那就需要解释它与其他产品的区别，同时说明如何开始使用它。如果产品涉及用户经常遇到的问题，例如计算机应用程序，您就需要以一种便于理解的方式提供适当的信息和细节。
2
以一种所有用户都能理解的方式编写。除非用户有技术背景，否则最好避免使用高度技术性的语言，代之以清晰易懂、简单明了的解释。文字的组织方式还要符合用户的思考方式；将产品特性按功能分组通常比按使用频率分组更好。
- 有时候，使用技术术语是没有意义的，比如创建一个图形化的软件应用程序，包括斐波那契数列和更常见的饼图和条形图。在这种情况下，定义术语并提供一些背景知识是很有帮助的，比如解释斐波那契数列是什么，以及它们在财务分析中的用途。
3
详细说明用户正在尝试解决的问题，然后再给出解决方案。把描述特性作为解决方案在营销产品时有用，但是一旦用户购买了产品，他们就需要知道如何使用。确定用户将要面对的具体问题，在用户指南中列出问题，然后给出相应的解决方案。
- 如果问题复杂，那就把它分解成更小的部分。列出每一部分的说明，说明如何解决或处理这一具体部分，然后依次解决接下来的每一个问题。通过这种方式分解信息称为“切分组块”。
广告

方法 2

方法 2 的 3:

用户手册的呈现方式

下载PDF文件

1
恰当的封面和标题页。你需要为任何用户指南制作一个封面，这不仅仅是一个参考卡片，还需要标题页，内容超过一张折叠的纸（长度为4页或更多）。
- 如果该手册受版权保护，还应同时在封面和扉页上列出版权公告。
- 如果有使用手册和相关产品的条款和条件，请将它们放在封面内页上。
如果用户文档超过了1个手册，请参考其他文档，并标注正确的版本号。如果有一个“如何使用本指南”的章节，也要写在前言中。
4
将说明、步骤和参考资料放在手册的正文中。尽管您可以告诉用户跳转到其他章节去阅读特定的内容，但在大多数情况下，程序和参考资料都应该单独作为一个章节。通过这种方式，用户就能更快地找到所需的信息。
- 步骤应在手册的指导部分中以一致的结构书写。先概述任务，然后描述用户需要做什么，以及他可能会看到什么结果。步骤应该编号，并尽量以动词开始。
- 参考资料可以包括选项列表、故障排除技巧和常见问题。在手册的末尾可以添加词汇表和索引，经常使用的术语列表也可以写在前面。如果手册少于20页，可以省略掉索引。
5
使用图像来辅助文本。图形图像（或屏幕截图）能比文本更好地说明手册中的某些要点，特别是在复杂的步骤中，用户需要通过可视化的确认后才能正确地执行这些步骤。生成图形图像可以使用计算机辅助绘图（CAD）或图形编辑软件，数码相机和照片编辑软件，或者屏幕截图，可用计算机自带的截屏工具或图形软件包含的截屏功能。
- 创建了一个图像后，将它保存为压缩格式，可根据你的计算机编辑软件所支持的格式来选择。对图片进行压缩，以便使其与页面更搭配，同时保留必要的细节。（如有必要，你可能需要将原始图像分割成部分，将相关的部分配合说明文字进行显示。）
- 如果你在步骤中插入了多张图片，要让它们的大小保持一致，长度或宽度相同，或者按照相同的比例缩放。这样能使图像对用户更具吸引力。同样的，如果用户手册显示彩色的屏幕截图，当你在电脑上创建屏幕截图时，需要确保截图采用了标准的颜色方案。
- 虽然像Photoshop和Paint Shop Pro这样的图形编辑程序提供了不错的截屏功能，你也可以使用如SnagIt之类的专用截屏程序，以便于修改、分类和注释屏幕截图。
广告

方法 3

方法 3 的 3:

设计可读性强的用户手册

下载PDF文件

1
选择一些可读性强的字体。虽然计算机可以支持许多不同的字体，但用户手册的目标是易于阅读。选择少数几种字体，使它们搭配得当。字体可以分为两种类型：serif衬线和sans serif无衬线字体。
- 衬线字体指主要笔画的末端有细微装饰线条的字体。衬线字体包括Times New Roman、Baskerville和Book Antiqua等字体。衬线字体最适合用户手册的主体部分中尺寸为10到12的大块文本。
- 无衬线字体只显示字体的笔画，无衬线修饰，包括Arial、Calibri和Century Gothic等。无衬线字体可以运用于PDF文档或网页手册，字体大小为8到10，但缺少衬线会使12号以上的字不便阅读。无衬线用在标题中适合选择大号字，而用于脚注和列和表中适合选择小号字。
- 一般来说用户手册适合普通字体，比如Arial或Times New Roman。不过，如果你要为科幻视频游戏编写用户手册，那就可能要用到装饰性的字体。（重要引文可用普通字体加斜体的方式来呈现。）
- 一旦您决定了要使用的字体，就可以创建一个测试页面，用来验证字体在纸张上的组合是否和谐美观。你还需要让手册负责人看一看，得到许可后再进行下一步。
2
请仔细考虑一下布局。选好用户手册的字体，需要决定页面上的所有内容如何布置。
- 通常需要将手册的标题或章节标题放在页眉或页脚中，一般的做法是在左边的页上使用手册标题，在右边的页面上使用章节标题。在页眉或页脚中要有页码，无论是在角落（页眉或页脚）还是在中心（仅页脚）。你可能希望每个章节或章节的第一页与其他页面不同，那就将页码放在页脚的中心，而后面的页面可以把页码放在页眉右上角。
- 你可能想把突显文本放在彩色或阴影框中，以便将其与文本的其余部分分开。一定要选择一种不干扰文本的颜色或阴影。
- 在边缘留出足够的空间，装订处留的空间大些。
3
考虑用户手册的装订方法。如果用户手册超过4页，需要装订在一起。虽然内部文件可以用订书机装订，但供外部使用的产品手册通常有以下三种装订方式：
- 侧边装订适用的纸张尺寸： 21 x 27.5厘米、21×35厘米或27.5 x 42.5厘米。很多不超过48页的简单手册就是这样装订的。
- 骑马线装订常用于第三方参考指南，汽车产品使用手册和其他长篇幅的手册也常用该方案。（JASC软件公司生产的Paint Shop Pro用的是骑马线装订手册。）
- 螺旋装订适用于复杂的使用环境，比如户外，它比侧面装订和骑马线装订更耐用。一些螺旋装订的手册会覆膜，以防止手册被弄湿或弄脏。
4
创建一个用户手册模板文档。许多文字处理和桌面编辑程序都含有为用户手册创建模板文档的功能，设置成功后，键入文字时文本就会自动以你设定好的字体和位置呈现。（实际上，本文最初是使用Microsoft Word模板编写的。）大多数此类程序包括一组预设的模板，你可以根据需要来进行修改，而不用从头创建。
- 文字处理和桌面编辑程序还有创建“样式”的功能，为页眉、页脚、标题和正文文本创建“样式”，预设字体和大小格式。您可以选择一个预设的样式名（例如，“Heading1”，“Normal”，“Quote”），或者创建自己的风格并自己命名。对于同一类型的文本，要尽可能符合已有样式的命名规则。（例如，Microsoft Word将标题的文本样式命名为“Heading1”、“Heading2”等，从主标题到几个级别的副标题都用该种命名格式。）试着预先创建你需要的所有样式，这样就不必在实际的写作过程中停下来创建。
广告