從項(xiàng)目交接看項(xiàng)目文檔管理

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

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

　　三、《需求說明書》：需說明產(chǎn)品的最初需求內(nèi)容實(shí)際對于我當(dāng)前接手的這個產(chǎn)品，需求說明書的重要性已經(jīng)大大降低了，因?yàn)楫a(chǎn)品已經(jīng)研發(fā)完成，且提供了完整的用戶手冊，但整理需求說明書的主要目的還是有兩個：

　　1、是要建立完整的項(xiàng)目過程追溯流程，為后續(xù)工作做準(zhǔn)備。

　　2、通過需求驗(yàn)證成果的有效及可用性。

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

四、《系統(tǒng)設(shè)計說明書》：系統(tǒng)設(shè)計說明書現(xiàn)在在這個時候已經(jīng)無法在考慮設(shè)計的問題，但此時應(yīng)該提供以下內(nèi)容：

　　1、系統(tǒng)的架構(gòu)設(shè)計及架構(gòu)在應(yīng)用過程的調(diào)整。并且最好可以提供架構(gòu)的弊病分析說明。

　　2、接口設(shè)計說明及接口的詳細(xì)規(guī)格及設(shè)計說明。現(xiàn)在的系統(tǒng)基本上都是松散的，通過接口標(biāo)準(zhǔn)從而最終實(shí)現(xiàn)系統(tǒng)的集成，所以，接口部分非常關(guān)鍵，這部分內(nèi)容一定要非常清晰和準(zhǔn)確。

　　3、如果現(xiàn)在無法再提供設(shè)計文檔，則建議通過第三方工具，根據(jù)成果代碼反項(xiàng)生成設(shè)計，并在此基礎(chǔ)上進(jìn)行文檔補(bǔ)充，看設(shè)計總比看代碼好很多，所以，這部分內(nèi)容應(yīng)該進(jìn)行提供。如果在新項(xiàng)目中，此部分內(nèi)容頁建議考慮，主要是規(guī)劃接口調(diào)用、對象職能及對象關(guān)系。

　　五、《數(shù)據(jù)庫設(shè)計說明書》

　　我本人還是十分重視數(shù)據(jù)庫設(shè)計的，雖然現(xiàn)在有很多的DAO的工具，而且也倡導(dǎo)對象建模，但實(shí)際在應(yīng)用過程中，完全做到的卻是少之又少，尤其是針對數(shù)據(jù)分析部分內(nèi)容。所以此文檔我認(rèn)為還是非常重要的。至于文檔的格式，因?yàn)榇朔矫嬉呀?jīng)非常“標(biāo)準(zhǔn)”化了，就不在進(jìn)行說明了。

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

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

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

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

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

　　《測試報告》：可以用測試報告對成果進(jìn)行說明，但我個人感覺《測試計劃》比《測試報告》更重要，因?yàn)闆]有一個好的測試計劃進(jìn)行指導(dǎo)，最終測試也就成為了一個成果描述環(huán)節(jié)了。

　　其中，建議使用Project進(jìn)行項(xiàng)目計劃管理，最好可以用Projectserver來進(jìn)行跟蹤，這樣聯(lián)工作日志也可以省略了。

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