2.6.2　設計文檔的分類

系統設計文檔可以分為以下幾類。

（1）總體設計文檔：描述系統的總體構成和運行機制。

（2）子系統設計文檔：描述構成系統的某個子系統的組成和運行機制。

（3）接口定義文檔：描述系統對外提供的接口。

（4）關鍵算法說明文檔：描述系統中的關鍵算法。

（5）數據表設計文檔：描述系統使用的數據表的設計，可能是數據庫的設計，也可能是其他存儲設備的設計。

……

以上這些設計文檔應該是相互獨立的，都有各自的主題和聚焦點。有一種錯誤的做法是，把這些內容都混雜在一個文檔中，這是我非常反對的做法。

將不同類型的設計文檔獨立存放的原因基于以下幾點。

（1）便于讀者閱讀。每個文檔都有特定的讀者，比較典型的是“接口定義文檔”，這個文檔是提供給系統的外部使用者的。外部使用者并不需要了解系統的內部設計。

（2）便于編寫文檔的人進行修改和維護。進行切分文檔后，在做修改維護時沖突的可能性會大大降低，同時也降低了設計文檔成為“巨型文檔”的可能性，對短小的文檔進行閱讀和維護的難度都更低。