为什么要写设计文档

My beloved woman love a man, please take good care of her.

 

为什么要写设计文档

我们在开发之前，为什么要写设计文档呢？我之前对设计文档就不怎么感冒，上头叫我写，我没不以为意，不怎么想写，也真的没写；然后过了两天又叫写，于是我就草拟了100来个字，写的是真的不行，后知后觉，写的是真JB烂，写成这样下面这样，说好听就是太简单了，难听点就是WTF，写成这样的话高手想指点下都难：

虽然后知后觉，但迟到总比不到好；当时记得开发周期快到了，然后和我过了下进度，发现我的思路走偏了，凉凉；然后让我再细化设计文档，感觉真心好，早就应该详细些设计文档了；细化了设计文档之后，带我飞的杨总-高级程序员的水平显露无疑，文档中的批注修改意见仅仅花了5分钟这样就OK了，了解一下；当时我就有一种后背发凉的感觉“每个不曾起舞的日子，都是对生命的辜负”；

随便截了一部分细化后的设计文档，重点是右边的批注，高水准显露无疑：

 

 

此次开发设计文档事件后，让我深深感受到了设计文档的重要性，再小结下：

怎么写设计文档：

根据用户在界面的操作流程来写开发设计文档思路会很清晰，想象着自己就是用户，下一步要怎么操作，点击哪里，然后前端会发送什么请求，请求在会有哪些参数，到了后台我需要怎么处理，这里就可能设计到一些技术比如缓存是用cache、redis，还是Map缓存呢之类的，然后又要返回给用户什么信息，到了前台页面又要如何展示，这样一步步下来思路就比较清晰了比较OK的。

为什么要写设计文档：

1. 有了详细的设计文档，编码的时候就可以畅通无阻了，就算是没有设计文档，没有细化的设计文档，到了编码的时候同样会阻塞；

2. 有了设计文档，后面可以直接方便的出接口文档和测试用例，对着设计文档的要点，很方便的写出测试用例；

3. 写设计文档，把关键的流程梳理出来，过了几个月之后自己看代码不知道当时为什么这么写的，还可以从设计文档一探究竟；

4. 最重要的一点就是（目前对我而已），出了设计文档，身边有大佬会给你指点，可以保证我们大的方向没有错，设计不当之处可以马上得到纠正，模糊不清的部分也会马上有了思路，大大减少了开发的时间和降低了编码的难度，也提高来团队及公司的工作效率；

5. So，设计文档要速度出，切勿怕出错，问题要及早暴露，出来混总是要还的，小老弟；

6. 设计文档至少要把大致关键的流程梳理出来，以及用到的实现技术，这样不仅编码畅通无阻，更重要的是会有人指点，勿怕设计文档会暴露出自己贼菜，内容至少如下：