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

2024-06-02 22:10:24

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

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

一、准备工作

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

二、写作思路

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

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

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

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

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

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

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

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

三、如何写使用手册目录

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

第二种

第三种

详细内容

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

四、具体功能点如何去写

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

如何写使用说明书或使用手册相关推荐

php写的软件帮助手册源码使用帮助源码html模版源码，系统依附HDSYSCMS内容系统
最近折腾好几天新写一套帮助中心模版,因为自己平时写软件之类都需要帮助中心,支持中英语两种同时录入.为什么要自己写这个帮助手册不是找云平台写,这个都因为SEO问题,这样SEO搜索来源涨了不少,这个是我们 ...
三菱fx2n64mr说明书_三菱FX2N-64MR-UA1/UL使用说明书FX2N-64MR-UA1/UL手册 - 广州凌控
最大的输入/输出点数:128点. 电源电压:100–240VAC. 输入点数:64点. 输出点数:64点. 输出类型:晶体管(源型). 耗电量:65W. 重量(kg):1.80FX2N-64MR-UA ...
今天完成一篇特殊的作文：写出《公司手册》的每个字
上周就给自己本周末定一个任务:写出公司手册第一版.定了计划就要完成. 现在是周日下午,在上海中山地铁内的麦当劳,吃完16元的套餐(本来是15元,我要求把冰可乐换成热红茶),开始写作. 这是一篇特殊的作 ...
hadoop写文件 java_写文件 - Hadoop 学习手册_教程_Java开发社区
HDFS - 写文件 1.客户端将文件写入本地磁盘的N#x4E34;时文件中 2.当临时文件大小达到一个block大小时,HDFS client通知NameNode,申请写入文件 3.NameNode ...
硬肝4.4w字为你写成Java开发手册
先来看一下本篇文章的思维导图吧,我会围绕下面这些内容进行讲解.内容很干,小伙伴们看完还希望不吝转发. 下面开始我们的文章. Java 概述什么是 Java? Java 是 Sun Microsyst ...
终于写完了！PyCharm操作手册 V1.0版本
给大家推荐一下我朋友阿亮,最近写的PyCharm操作手册以下为第三人称之前有很多新手同学问我,有没有PyCharm的相关教程.我开始觉得这只是个工具,用多了自然就会,所以也没有太在意.直到有一天又 ...
github速成手册
首先感谢github,有了github的建主页功能,才有了自己的网站(http://www.amswf.com/).并使楼主省了买服务器的银子.所以楼主决定开博的首篇文章用来写一个github入门手册 ...
WiFi穿墙手册：解读天线、dbi、发射功率和无线信号的关系
WiFi穿墙手册:解读天线.dbi.发射功率和无线信号的关系一直想跟大家探讨无线路由穿墙这个话题.怎么选购一个适合自身空间环境的路由器,确保各角落都能用得到WiFi确实是大家常常遇到的问题.不时都看 ...
腾讯高工保姆级“Java成长手册”，层层递进，全是精华
好像在当今这个社会,什么事物都会分成不同的层级,不管是物件还是人,虽然当今这个时代,是一个人人平等的时代,但是现实中还是有着各种不同的层级. 作为程序员的我们,也同样是一样的,有的是在小公司的,有的是 ...

最新文章

热门文章