用户手册怎么写

六六 TOP1 478

用户手册撰写包括以下内容:1、封面、2、目录、3、修订记录、4、系统概述、5、功能说明、6、手册说明方式。用户手册撰写步骤是:1、定义受众;2、表达用户手册的目的;3、分类操作方法;4、确认已记录的步骤;5、创建图形;6、记录其他部分;7、简明和全面;8、格式易于阅读;9、验证、校对并审阅。

一、用户手册是什么

用户手册,亦称用户指南、产品手册,旨在通过对产品功能的清洗解释,为特定的使用者提供帮助。它能够帮助你的用户更好的理解、使用你的产品或服务。通常由产品经理或技术人员编写。

二、用户手册的内容

1、封面

包括公司logo、公司名称、软件名称、版本号;

公司logo、公司名称:注明操作手册所属机构,引发用户共情

软件名称:想对多角色的软件,可以加上端名,例:**顾问端,***家长端;

版本号:区分操作手册时效性

2、目录

增强用户导读性,让用户快速跳转到想定位的模块。

3、修订记录

通过修订记录可查看版本迭代的内容。

4、系统概述

让用户对产品的系统有个大致的了解,可以注明开发前期产品调研的用户痛点是什么,开发团队是怎么解决的,系统的主流程是什么。

5、功能说明

在书写功能模块时,要尽量做到简洁易懂,保证操作手册的可读性。

模块的划分一般有两种:按系统页面去划分和操作场景划分,我比较推荐操作场景划分,更贴合用户的使用习惯,阅读起来更容易。

注意:要说明如果遇到错误步骤或异常步骤,用户应该如何操作

系统截图:①系统截图要截全屏,方便用户快速定位;②重点内容有标识,让用户不用思考就知道步骤讲述的按钮在哪/内容在哪填写。

6、手册说明方式

说明方式多种多样,一般为:world、ppt、视频教程、智能客服。

对于复杂的逻辑内容,以图文并茂的方式呈现给用户,可以帮助用户更好的了解系统。从接受程度来看,视频更直观且会更容易让用户接受。

文档编写的规则一般是:从整体到局部再到细节,先做系统概述,让用户知道系统是干什么的;再进行功能说明,让用户了解基本功能和使用场景;最后对功能进行详细说明,告诉用户怎么使用。

三、用户手册撰写步骤

知道了用户手册有哪些内容,那么在撰写前和撰写时要遵循哪些步骤呢?

1、定义受众

定义受众有助于你选择需要什么样的信息以及如何呈现。它还可以帮助您决定需要在指南中包含多少详细信息。

例如,如果受众是专业技术人员,则微波炉的用户手册可以包含没有任何解释的技术短语,但如果受众是最终消费者,则不能这样做。

2、表达用户手册的目的

应认识到该手册的读者需要什么来学习使用该物品。制定强调说明如何使用产品和如何维修产品的用户手册大有不同。
例如,如果您正在为将使用新卷发棒的美发师编写用户手册,则这与以指导如何维修或保养卷发棒为目标编写文档非常不同。

3、分类操作方法

在初稿开始时,您必须建立一个步骤列表,这些步骤是有人需要遵循的,以执行文档打算阐明的任何任务。然后,您使用在正文中创建的列表,并尝试自己执行这些任务。
通过这种方式,您将判断该列表是否足够,或者需要进行一些修改。不断修改指南的说明,直到它变得易于遵循。

4、确认已记录的步骤

这样编写的最新草案必须纳入手册的操作正文。建立材料或资源的全面列表,这样读者就可以更简单地提取他们需要的信息。对于所描述的步骤,请使用项目符号和编号列表,以帮助用户逐步遵循文档。

5、创建图形

定义步骤后,研究图形元素必须放置在何处,以便帮助用户遵循和实施指南。您可以开发适当的图形、插图或图表,将其与步骤一起包含在打印本中。

6、记录其他部分

一旦用户手册的主要部分被很好地记录下来,重点是构建主题的其他部分。在这里,你需要一个介绍和结论部分。

  • 引言部分:通常,用户手册的引言部分以一般产品概述和感谢客户选择其产品的信息开始。
  • 结论部分:结论部分以如何与公司沟通的信息和相关细节结束。它还包括可能需要的保证、许可协议、安全声明和免责声明。

7、简明和全面

用户手册需要简明和全面。用户手册必须采用技术写作风格。需以尽可能有限的文字传输最大的信息。如果一个过程可以用几句话或几条说明来描述,那么就不需要罗嗦,也不需要让手册冗长。
直截了当地回答问题,回答所有需要解决的重要问题。记住,过多的文字会造成信息过载。

8、格式易于阅读

拥有用户需要的所有重要信息对于用户指南至关重要。此外,本文件必须易于阅读和用户友好。为此,请考虑以下几点,它们有助于设置手册的格式,以便于阅读:

  • 不要过小字体。根据读者的不同,您可能需要使用较大的字体。
  • 选择合适的字体样式。
  • 这些步骤必须以编号列表的形式呈现。
  • 利用表格和/或项目符号列表突出显示重要数据或信息。
  • 插入标题以突出显示从一个段到另一个段的转换。根据需要在标题段内包含子标题。

9、验证、校对并审阅

  • 验证准确性:确保用户指南或手册中包含的信息准确无误。说明必须说明如何遵循特定程序或使用特定设备。你应该检查步骤的顺序、语言的清晰度和包含的术语。
  • 校对:仔细校对,确认您的用户手册没有任何标点符号、语法和拼写错误。印刷错误可能会让读者感到困惑。这也反映了公司、产品或品牌的糟糕表现。
  • 审查:当您认为手册已经准备好时,请其他人审阅该文档。通过这种方式,可以获得有关总体指南的格式和内容以及指南是否需要任何调整的反馈。

回复

我来回复
  • 暂无回复内容

联系我们
关注微信
关注微信
分享本页
返回顶部