如何撰写文档

今日听了魏老师的如何撰写产品文档的课程，收益良多。

先说下撰写文档的前提：

1、明白是给rd/qa写的，明确他们关心的问题和角度；

2、能写多细写多细；伪代码是最好的；

3、做好前期准备工作；

a）梳理思路；

b）流程图；

c）原型图；

d）落实文档；

4、重视内外需求评审；需求评审是内部了解你需求的人对你的需求、文档的补充和意见；

5、一图胜千言

6、别说废话，说话写字注意重点，明白你要干什么，言简意赅表达出来；

另外，听完演讲最重要的是，不要犯重复的错误，这适用在产品的任何事上，方法论也是一样，上次和师父讨论也指出这是最重要的问题，最笨的方法是建立错题本；我相信你一定有简单的办法；

另，总结下写文档模板：

1、做好文档管理，包含上线版本、日期、变更记录等；

2、需求背景（你为什么做这个需求？发现了什么问题，怎么解决？）

3、需求收益（做完的收益是什么？产品/公司层面收益，用户收益，可衡量的指标）

4、需求流程图；

5、需求描述（按模块分，前端交互（ui图）、后端交互（流程图/泳道图）、边界情况、异常情况、断网情况、性能要求）

6、qa需要特别注意的点；

7、埋点

以上标粗的，是我经常遗漏的点，之后需要注意。。。