前言
为啥突然想要要写这篇文章
因为要写某个系统的操作手册
想写一份比较好的操作手册,从用户的使用场景出发
记录下自己写一份「比较好」的操作手册的思路
定义
操作手册的定义
操作手册的目的
操作手册的内容形式:从场景出发,明确操作流程(步骤),图文结合,并给出常见问题的解决方案
如何写
先有个整体的认知,明白这个系统是干什么用的,在上下游系统中处于什么样的地位,有什么依赖的,它的产出是什么
接着从实用的角度出发,抽出几个非常常见的使用场景,明确操作流程、步骤
系统介绍
为什么角色解决什么样的问题
系统架构图
形成整体的认知
常见场景
- 场景名称
- 面向角色
- 解决什么问题
常见问题
意见反馈
附录:功能模块
介绍不同的功能模块