隨想：軟件開發文檔

    其實做哪一行都一樣，要想做好一件事，需要有個標准，有個規范，而且這個規范不是條文口號式的，而是實實在在的能為工作帶來品質提升的內容。從事這個行業有好幾年了，經歷過小的，大的，標准的，非標准各種企業，感受頗深的一點就是：文檔工作沒有一家企業做得好的。

    我講的文檔指的是軟件開發文檔。從實用的角度出來，我認為傳統的分析、設計、編碼、測試這個統一模式下的文檔太泛化，講得比較虛，跟實際相差太大。相差在哪裡呢？差在傳統的文檔規范只考慮到的縱向的問題，它們將軟件考慮為一個項目。卻沒有軟件進行橫向分割，沒有把軟件中包括的技術內容和業務內容合在一起不加區別。而實際的情況是：軟件包含技術和業務這兩部分內容。如果不將他們分開描述，這個文檔的專業性就不強，描述的問題也無法做到清晰、准確。也正因為如此，很多軟件公司未能按這個理論上文檔規范將文檔工作做起來，從而導致很多問題。
   
    我認為，從真正實用、有效的角度出發，軟件開發文檔可分為三類：
    一類是純技術文檔。包括類、接口的設計，單元，編碼。。。等等內容，這類文檔不必要求詳細到每一行代碼(最詳細的文檔其實是源代碼)，但必須要描述清楚設計思路，開發基類（框架）的類圖，代碼的總體結構和包或單元的分布結構；
    另一類是業務文檔。即軟件要實現的業務功能的文檔，包括具體的業務邏輯的描述，這類文檔要求邏輯嚴密，詳細具體的描述每一個業務邏輯，以及業務邏輯之間的關系； 
    第三類是程序設計規格說明書。每一個開發模塊或界面都要有一個相應的規格說明，它的內容是前兩種文檔的內容的綜合化和具體化。它詳細地描述一個模塊的業務功能邏輯，代碼實現方法，輸入輸出的表現方式。