产品说明文档怎么写(怎么写产品说明书)
导语:业务中台新人浅谈,如何写好产品说明文档
(一)前言由于近期内部某一类岗位的同事人数快速增加,且他们会频繁使用到内部多个系统平台,经常就能看到:新来的同事总是反反复复的找老同事帮忙求助系统使用的问题;且这是一个在各产品线内部都非常痛的问题。
即使各个产品线都自己出了一些说明文档,但是业务端的同事并不会对整体的系统进行详细的介绍,仅仅是站在具体问题下如何操作的步骤说明;
新同事上来仍然是一脸蒙蔽,这些系统平台是做什么的?和我的工作有什么关系?我是只能使用该平台上的这些功能么?其他功能是做什么的,我要怎么使用?
因此,花了将近2周的时间在这件事情上:写一份面向业务端某个核心岗位所有同事都能看懂理解,能够真正解决他们内部重要系统平台操作使用的问题。
哎,可能也会有同学问:这些产品说明文档在产品上线的时候,产品经理不应该就写了吗?
是的,产品经理的确是写了,但是产品经理的同学更多的是站在产品说明的角度,并没有考虑到如何结合业务场景以及这一类岗位的同学的视角上;
(二)如何写好一份面向业务端的产品操作使用说明1.做好调研
为了能够更好的了解业务端这类岗位的同事,尤其是新同事对于产品操作文档的需求以及现有的操作文档不足的反馈地方,需要进行一轮小的调研;
首先,了解现有的各个产品线给出的操作说明文档,重点撰写的内容是什么;
其次,调研已经使用过现有的操作文档进行系统操作的同事了解他们目前的痛点和需求是什么;
最后,也需要调研一些老同事,了解新来的同事往往在系统操作上会高频询问的问题是什么?
2.整理形成操作说明的大纲
根据调研结果,罗列出整个说明中各个模块的主题、以及其下需要包含的内容细节和阐述的颗粒度到什么程度;
然后进行自我审视:
(1)内容结构是否清晰易懂?
(2)是否能解决/满足调研过程中同事们的需求和痛点?
(3)是否还有遗漏未被提及的注意点?
3.完成最终的说明文档
由于是系统操作类的产品说明文档,整个说明所包含的内容会非常的繁多,且涉及到具体功能操作的部分又特别的细节,因此一定要做到逻辑清晰、切中重点;
首先,为了能够让业务端的同事更好的了解整个说明文档的撰写逻辑,在说明的最前面先给到了一个《使用说明》:
(1)包含简单的介绍
(2)使用过程中遇到问题可以寻求帮助的人
(3)一个可填写反馈的问卷
(4)整个说明文档所包含的模块和每个模块下的重点
其次,站在整个内部所使用的全部系统的角度进行系统层面的介绍,使得业务端的同事能够快速的了解内部所使用的系统、对他们来说需要重点关注的系统平台、以及各个系统平台之间的协作关系是什么;
然后,站在业务端该类岗位同事固定业务工作流程的角度,使得业务端的同事能够结合着自己的整个工作流程以及系统所支持的功能进行快速了解,知道自己的哪类工作下,有什么系统平台能够提供什么类型的功能支持;
最后,就是具体的业务场景下,业务端的同事需要染成的系统操作动作以及如何操作的流程和注意事项说明啦~
(三)结尾写完这个说明文档并不意味着这项工作的结束,因为真正的使用者是业务端的同事,因此,需要再一次获得来自业务端同事的反馈;并且这个过程中,系统平台会不断的有新的版本的上线,也需要进行定期的更新维护。
本文内容由小莉整理编辑!