如何写使用说明书或使用手册

如何写使用说明书或使用手册

作为一个测试人员，有时需要输出产品使用说明书或使用手册的文档，以下是分享的一些经验。

一、准备工作

1、了解业务流程和产品的功能（了然于心那种）。
2、熟悉使用操作。

二、写作思路

1、第一种写作思路，是完全按照功能性，按照一定的顺序，编写完成使用手册。
第一种，适用于操作简单，或是不用分权限进行操作的硬件使用手册或产品使用手册

例如：描述不良反应模块的功能
     不良反应

      作用：记录服药期间出现的不适反应。

     点击【不良反应】，进入到不良反应页面，点击添加，选择一个药品，填写发生时间、持续时间、不良反应，点击【提交】，添加成功，显示已填写的不良反应信息。

2、第二种是根据使用角色来进行划分，然后根据使用角色的不同，来进行编写。
这种方法适用于需要多角色，参与使用的系统或功能。

例如：一个“狼人杀”游戏

     狼人：拥有杀人的能力
     操作说明：在天黑请闭眼时，法官开启对话，此时狼人，指定一人，点击实现杀人功能。

     预言家：拥有查验能力
     操作说明：在天黑请闭眼时，法官开启对话，此时预言家，指定一人，点击实现查验功能。

三、如何写使用手册目录

1、如果是客户端类型或硬件类型的可以参考以下目录
第一种

第二种

第三种

详细内容

2、如果是web端的直接从功能开始写即可，这里不再举例

四、具体功能点如何去写

1、避免使用我/你/他/们等等带有人称性的字，用用户职称等词去代替。
2、使用图片，具体功能时截功能按钮图片，使用户有直观的感受，可以更好的进行使用.。
3、简练语言，有重复的操作在文档里可以只体现一次，取消/删除等操作可以略过。
4、编写时，注意应该写正确操作，误操作情况可以单列一个模块编写。