如何编写软件的操作手册?

重庆夜景,图片来自朋友圈。

企业上ERP系统的时候,顾问通常需要编写操作手册给用户,当然最好是由关键用户来给最终用户编写操作手册,那样才能保证知识的转移到位。

但是经常有顾问觉得自己已经用尽洪荒之力而且写得很细,但是客户还是表示看不懂。

错误的写法举例:

1 权限管理

1.1 职责设置

1.2 角色设置

1.3 用户设置

。。。。。。

错误的写法是按照软件的功能节点编写。

正确的写法举例:

1.如何给新用户设置权限

2.如何给老用户变更权限

3.用户离职的时候如何处理

。。。。。。

正确的写法是按照用户的使用场景来编写。

也就是说:

要站在用户的角度来写,不要站在产品的角度来写。

另外,在格式上也要有所注意。

比如,在截图的时候,如果只需要关注左上角的几个按钮,那么就截出左上角就可以了,不要把全屏幕都截下来,全屏幕的图放到WORD里面完全看不清楚你要读者看的按钮长什么样子。

截图和下一段字之间要空出一行,挨得太紧看起来有泰山压顶的压迫感。

一定要插入目录,方便用户查找他要用的那个操作。

(0)

相关推荐