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. 設計文檔至少要把大致關鍵的流程梳理出來,以及用到的實現技術,這樣不僅編碼暢通無阻,更重要的是會有人指點,勿怕設計文檔會暴露出自己賊菜,內容至少如下: