愛華網(wǎng)在學寫文檔初期，我總想去套一些國標的文檔模板，套了半天，經(jīng)常發(fā)現(xiàn)寫出來的文檔，連我自己都沒有看懂，因此，也總結出來一條基本道理：生搬硬套某些文檔模板，機械式的對文檔模板進行填表的操作并不能夠得到系統(tǒng)所真正需要的設計文檔。
編寫設計文檔會起到兩個作用：
一，在編寫設計文檔的過程中對系統(tǒng)進行一個全面思考的過程，由于設計文檔也由需求分析，系統(tǒng)設計，詳細設計這樣逐層深入的設計的過程，因此這有助于系統(tǒng)設計者站在各個不同角度來思考系統(tǒng)，十分有助于全面深入整理整套系統(tǒng)以及發(fā)現(xiàn)一些潛在問題，這是系統(tǒng)開發(fā)的一個十分重要的過程。
二，我們都知道，現(xiàn)在在企業(yè)里開發(fā)軟件，一般都不會是一個人從頭到尾進行開發(fā)，多數(shù)系統(tǒng)都是有一個團隊進行設計開發(fā)，這個時候，設計文檔就起到了一個十分重要的信息傳遞溝通的作用，而且在系統(tǒng)開發(fā)完成，交付使用后，后期也會有很多的維護工作，這個時候，文檔就更顯其作用了。
基于以上兩個作用，我覺得編寫文檔要了解以下幾點：
一，我們了解我們所要寫的是什么文檔，它的作用是什么，它應該包含的內(nèi)容都有哪一些，這是寫文檔的基本前提。
二，編寫文檔一定不能是應付式的，一定要認真的思考，否則，你就失去這個良好的思考過程。
三，文檔是為了表達信息，不是為了符合某種標準，所以，不要過于遷強去適應某種標準，但是，如果既能符種一些通用的文檔規(guī)范，又能將信息表達清楚，那當然更好了。
三，文檔的格式應該清晰明了，要讓人一看目錄大綱，就對文檔整體分布了然于胸，
四，內(nèi)容表達重在清楚，關鍵是要將設計思想表達出來，不在寫太多冗余性的文字，盡可能配上一些圖形來表達思想，因為，人對圖像信息的吸收比文字來得快。
所謂磨刀不誤砍柴工，寫文檔就是一個磨刀的過程，刀是砍柴的工具，同樣，設計文檔也是軟件系統(tǒng)設計的一個基本工具，古人不是也有過精辟的結論嘛：“工欲善其事，必先利于器”，我們在系統(tǒng)開發(fā)前期，將這些工作完善了，那么系統(tǒng)開發(fā)起來就會更加順利，項目的成功率也就更高，后期維護也會更輕松，因此，設計文檔同時也是一種功能當代，利在千秋的工作，一定要注意做好。
