用户手册是文字版指南,它可以是纸质的或电子文档(PDF或XPS格式)的形式,内容为如何做某事或如何操作某物。虽然“用户手册”通常被认为是计算机软件指南,但用户手册也适用于电脑和其他电子设备,如电视、音响、电话系统、MP3播放器,以及家用电器、草坪和花园设备。好的用户手册有助于用户了解产品的特性,同时教他们如何有效地运用这些特性,而且排版可以方便阅读和查找。在编写有效的内容和设计用户手册的布局时,需要考虑以下事项。
01 弄清你的用户是谁。要编写一个成功的用户手册,你需要先研究用户概况,无论是正式地创建一个书面文件,还是非正式地方式,都要花时间分析用户的特点。这样的概要文件非常有用,不仅有助于团队编写用户文档,而且还有助于将产品本身从概念转换为成品。在构建用户概况时需要考虑的事项包括: 用户会在哪里使用用户指南,比如在家里、办公室、远程工作地点或汽车上。这不仅能决定用户手册的内容,还能决定要采用的样式。 用户如何使用用户指南。如果手册的使用频率低,用户只会偶尔翻看或查找信息,那就应该采取参考文件的形式。如果使用频率高,用户在一开始就得经常查阅,那么参考部分应该附带一个“入门”章节,并说明产品将用于哪些最常见的任务。 用户对该产品或其他类似产品有多少使用经验。如果你的产品是新产品或与同类产品有很大差别,那就需要解释它与其他产品的区别,同时说明如何开始使用它。如果产品涉及用户经常遇到的问题,例如计算机应用程序,您就需要以一种便于理解的方式提供适当的信息和细节。
02 以一种所有用户都能理解的方式编写。除非用户有技术背景,否则最好避免使用高度技术性的语言,代之以清晰易懂、简单明了的解释。文字的组织方式还要符合用户的思考方式;将产品特性按功能分组通常比按使用频率分组更好。 有时候,使用技术术语是没有意义的,比如创建一个图形化的软件应用程序,包括斐波那契数列和更常见的饼图和条形图。在这种情况下,定义术语并提供一些背景知识是很有帮助的,比如解释斐波那契数列是什么,以及它们在财务分析中的用途。
03 详细说明用户正在尝试解决的问题,然后再给出解决方案。把描述特性作为解决方案在营销产品时有用,但是一旦用户购买了产品,他们就需要知道如何使用。确定用户将要面对的具体问题,在用户指南中列出问题,然后给出相应的解决方案。 如果问题复杂,那就把它分解成更小的部分。列出每一部分的说明,说明如何解决或处理这一具体部分,然后依次解决接下来的每一个问题。通过这种方式分解信息称为“切分组块”。
尽可能使用字段代码或文本变量。您可以为它们赋值,例如产品名称、手册或章节标题,并预存在文档中。当您预览或打印该手册时,文本将应用该变量。如果产品的名称或手册名、章节名发生了变化,那么通过更改文本变量的值来更改信息会比通过搜索和替换文档更容易。