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