撰寫詳細設計文檔後的一些反思

不久前加入一家新的小公司，老闆讓我寫詳細設計文檔。我開始以為不就詳細設計文檔嘛，以前看别人寫了這麼多，自已雖說從沒寫過文檔（任何文檔，代碼裡的注釋），但也不緻于在這種小事上應付不了。但是真正做起來不是我想的那樣簡單。現在糾正一下自己以前的誤解：

1、 寫文檔隻要是個人都會，沒啥技術含量。

-----寫文檔雖然不需要太深的技術，但是章節安排、格式設定、斜體、引文，這些小技巧不見得每個程式員都會用，或者有些人壓根不清楚這些小技巧幹什麼用。這些小技巧運用不當可能引起讀者對文檔的誤解。

-----文檔章節安排合适，可以使讀者對作者的整體表達有個清晰的認識

-----格式設定恰當，字型、字号合适，文檔就既不會單調乏味，又顯得詳略得當，節約讀者了解文檔花費的時間。

2、寫文檔太費時間，不值得花這麼多時間。

-----寫文檔太費時間，證明你思路還不清晰，是以寫文檔的過程正好可以理清一下你的思路，避免後期返工導緻更多時間的浪費

-----寫文檔太費時間，也許是你寫作功底還不行，這恰恰警醒你需要想辦法來提升一下你的寫作功底

3、程式員隻要技術牛就行，會不會寫文檔不重要

-----文檔不會寫，技術一定牛不起來。技術牛人一定是通過不斷總結自己所學，不數積累才牛起來。程式員不會寫文檔，很難積累，怎麼可能牛起來。

-----我想大部分程式員通過閱讀技術書刊來擷取技術知識。不妨反過來想一下， 如果那個書刊的作者寫作功底不怎的，你會有興趣讀下去嗎，你能讀懂嗎。

-----文檔不會寫，表達能力肯定也是不行的。表達能力不行，思路一定是紊亂的。思路紊亂，寫代碼的花費的時間就更長，返工的可能性也越大，出BUG的可能性也越多，這樣的程式員隻能算碼農，對怎個團隊的價值不大。IT行業最不缺的就是碼農，碼農想提升自己的工資， 難！

轉行做Java開發也有兩年多了。回想這兩年多時間的經曆，心酸。