從項目交接看項目文檔管理

　　《計劃管理說明文檔》：如果有完整的Porject計劃是最好的，但此文檔一定要注意的是其準確性，在用Project進行計劃管理時，往往是項目進展時間越長，變更越多，計劃維護就越困難，此時就有可能計劃已經無法反應實際的項目進展情況了。計劃管理文檔一定要仔細研究，整個項目計劃是否安排妥當，哪些任務制定了但沒有完成，哪些任務取消了，這些取消的任務是否是屬于預定的功能要求，哪些環節就沒有進行，哪些環節多次重復，有哪些人員工作過程中發生了任務的中斷變化，都可以從計劃管理說明文檔看出，這樣更有利于評估項目的實際情況，風險情況，并可以根據前階段未完善的內容進行后續完善。同時，很關鍵的一點是，這些任務中是否存在非正常情況，譬如：你認為很難的技術研發工作在短時間內卻已經完成，這都需要注意，并了解實際情況。最終通過計劃管理說明確文檔定是否預定的目標已經全部完成。而已經完成的內容應該和以上提交的成果說明是一致的，此部分如果不存在文檔，就需要根據相應的成果內容及人員對整個過程進行文檔補充。此文檔完成后，也可成為后續管理的一個基礎，進行優化處理。

　　如果沒有計劃管理文檔的話，補充的時候，則建議采用Project來完成，前一個成果提交文檔，并且最好可以采用WBS來組織任務的安排，將已經提交的對應到相應的任務中。通過前一文檔狀態的說明，將未完成的內容做標記，并且看是否存在同樣的任務不同的成果表現形式的情況，這時應該是屬于重復性任務，也做標記說明。

　　三、《需求說明書》：需說明產品的最初需求內容實際對于我當前接手的這個產品，需求說明書的重要性已經大大降低了，因為產品已經研發完成，且提供了完整的用戶手冊，但整理需求說明書的主要目的還是有兩個：

　　1、是要建立完整的項目過程追溯流程，為后續工作做準備。

　　2、通過需求驗證成果的有效及可用性。

　　需求說明書是一個可簡可繁的一個文檔，在這個項目中，需求說明書更多的是從用戶手冊中來提取需求了，實際的意義并不是很大。但如果是做一個新的項目，則需求說明書應該是僅最大可能的對用戶業務進行一種還原描述，不要摻雜個人的理解。至于是否可以實現，怎么實現是后續工作的事情，不是這個環節的內容。

四、《系統設計說明書》：系統設計說明書現在在這個時候已經無法在考慮設計的問題，但此時應該提供以下內容：

　　1、系統的架構設計及架構在應用過程的調整。并且最好可以提供架構的弊病分析說明。

　　2、接口設計說明及接口的詳細規格及設計說明。現在的系統基本上都是松散的，通過接口標準從而最終實現系統的集成，所以，接口部分非常關鍵，這部分內容一定要非常清晰和準確。

　　3、如果現在無法再提供設計文檔，則建議通過第三方工具，根據成果代碼反項生成設計，并在此基礎上進行文檔補充，看設計總比看代碼好很多，所以，這部分內容應該進行提供。如果在新項目中，此部分內容頁建議考慮，主要是規劃接口調用、對象職能及對象關系。

　　五、《數據庫設計說明書》

　　我本人還是十分重視數據庫設計的，雖然現在有很多的DAO的工具，而且也倡導對象建模，但實際在應用過程中，完全做到的卻是少之又少，尤其是針對數據分析部分內容。所以此文檔我認為還是非常重要的。至于文檔的格式，因為此方面已經非常“標準”化了，就不在進行說明了。

　　六、《測試報告》這個項目中是不需要了，如果是一個新的項目則建議由測試計劃起進行。

　　基本上就是這么多了，應該說文檔不少，但，是一個完整的流程，項目最初啟動的時候，應該建立文檔規范，文檔不要多，但要可以對項目的每個環節都有描述說明的。我見過一個項目光需求說明就有很多份不同的文檔，很頭疼，而且后期的維護也會很麻煩。建議每個環節就一份統一文檔。制定大家習慣的閱讀方式(這點很關鍵，否則大家都不看)，由大家共同維護完成。做一總結：

　　《需求說明文檔》：建議先將需求進行分解，然后用表格進行說明。如果條件允許，那就用RequisitePro管理需求，實現跟蹤。

　　《系統分析設計文檔》：建議采用Rose，需求用例一定要有，哪怕顆粒度大一些，在需求用例部分進行需求分析的說明，而且要說明規格要求。組件及類圖一定要有，規范接口調用規則，組織代碼結構，建立良好的系統框架。其中說明組件或類職能。此部分不一定完全由設計人員完成。有可能的情況下，提供活動圖。程序員對活動圖的興趣要高于時序和狀態圖。可以用SoDA產生相應文檔(只讀)供開發查詢使用。不一定一個Rose文件，可以多個，如果要拆分，對應需求拆分。

　　《數據庫說明書》：建議用PD，然后自動生成文檔(只讀)，供開發查詢使用。

　　《測試報告》：可以用測試報告對成果進行說明，但我個人感覺《測試計劃》比《測試報告》更重要，因為沒有一個好的測試計劃進行指導，最終測試也就成為了一個成果描述環節了。

　　其中，建議使用Project進行項目計劃管理，最好可以用Projectserver來進行跟蹤，這樣聯工作日志也可以省略了。

　　采用版本工具進行文檔管理，一定要，非常重要。