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

1、從項(xiàng)目交接看項(xiàng)目文檔管理項(xiàng)目文檔對(duì)于項(xiàng)目管理的作用已經(jīng)不用再講了，但文檔的管理卻又通常是項(xiàng)目管理中最簡(jiǎn)單忽視的內(nèi)容。實(shí)際對(duì)于任何一個(gè)項(xiàng)目而言，文檔一定要有的，但不一定要多，只要可以說(shuō)明問(wèn)題就行了。 最近正在接手一個(gè)項(xiàng)目，就以此項(xiàng)目為例， ，說(shuō)一下我的體會(huì)。這個(gè)項(xiàng)目已經(jīng)開(kāi)發(fā)完成，并且已經(jīng)上線運(yùn)行，具備了一定的客戶群體。接手這個(gè)項(xiàng)目時(shí)，此項(xiàng)目只有成果，沒(méi)有過(guò)程。僅有一份完整的用戶手冊(cè)。 針對(duì)此狀況，提出要求，需補(bǔ)充以下文檔： 一、成果說(shuō)明文檔：需說(shuō)明當(dāng)前全部可提交成果、成果內(nèi)容描述及成果評(píng)估。 成果描述至少需要描述以下內(nèi)容： 1)成果存在形式及現(xiàn)狀：針對(duì)軟件項(xiàng)目而言，基本上成果都是以可運(yùn)行代碼形式

2、存在，但在此一定要明確說(shuō)明代碼的現(xiàn)狀，是否經(jīng)過(guò)測(cè)試，假如經(jīng)過(guò)測(cè)試，需提交相關(guān)的測(cè)試報(bào)告，假如沒(méi)有經(jīng)過(guò)測(cè)試，那是否已經(jīng)完成，完成后，假如未完成則進(jìn)行到什么程度，尤其是假如沒(méi)有注釋的代碼，應(yīng)明確交代代碼實(shí)現(xiàn)的功能描述及接口描述。 2)成果研發(fā)過(guò)程說(shuō)明：主要說(shuō)明成果的追溯過(guò)程，此代碼從何而來(lái)，是否具備相應(yīng)的計(jì)劃內(nèi)容，假如沒(méi)有，這成果的上一個(gè)環(huán)節(jié)是什么，以代碼為例，代碼上一個(gè)環(huán)節(jié)是否有設(shè)計(jì)，設(shè)計(jì)上一個(gè)環(huán)節(jié)是否有需求分析等等。這部分代碼是依據(jù)什么來(lái)進(jìn)行的研發(fā)。假如某個(gè)成果沒(méi)有追溯到最初環(huán)節(jié)，就需要留意了，這部分內(nèi)容就是風(fēng)險(xiǎn)了。 3)成果可用性說(shuō)明：并不是最終提交的成果就一定是有效、可用的?；蛟S會(huì)隱蔽許多

3、的問(wèn)題，這需要任務(wù)的相關(guān)擔(dān)當(dāng)人進(jìn)行可用性描述，我們作編碼的都知道，在特定的狀況下，可能會(huì)采用一種臨時(shí)方案去實(shí)現(xiàn)一個(gè)功能，等最終集成時(shí)再去修正，但許多狀況下這種臨時(shí)方案都成為了最終方案。所以，一定要對(duì)成果進(jìn)行有效性說(shuō)明，假如沒(méi)有的，就一定要進(jìn)行嚴(yán)格的測(cè)試驗(yàn)收。 4)成果責(zé)任人說(shuō)明：一定要有，不是追究責(zé)任，而是便于溝通。 文檔制作說(shuō)明： 此文檔建議采用表格進(jìn)行說(shuō)明，假如可以建議采用Excel，這樣便于使用跟蹤管理，如下： 二、計(jì)劃管理說(shuō)明文檔：假如有完整的Porject計(jì)劃是最好的，但此文檔一定要留意的是其精確性，在用Project進(jìn)行計(jì)劃管理時(shí)，往往是項(xiàng)目進(jìn)展時(shí)間越長(zhǎng)，變更越多，計(jì)劃維護(hù)就越困難

4、，此時(shí)就有可能計(jì)劃已經(jīng)無(wú)法反應(yīng)實(shí)際的項(xiàng)目進(jìn)展?fàn)顩r了。計(jì)劃管理文檔一定要認(rèn)真研究，整個(gè)項(xiàng)目計(jì)劃是否支配妥當(dāng)，哪些任務(wù)制定了但沒(méi)有完成，哪些任務(wù)取消了，這些取消的任務(wù)是否是屬于預(yù)定的功能要求，哪些環(huán)節(jié)就沒(méi)有進(jìn)行，哪些環(huán)節(jié)多次重復(fù)，有哪些人員工作過(guò)程中發(fā)生了任務(wù)的中斷變化，都可以從計(jì)劃管理說(shuō)明文檔看出，這樣更有利于評(píng)估項(xiàng)目的實(shí)際狀況，風(fēng)險(xiǎn)狀況，并可以依據(jù)前階段未完善的內(nèi)容進(jìn)行后續(xù)完善。同時(shí)，很關(guān)鍵的一點(diǎn)是，這些任務(wù)中是否存在非正常狀況，譬如：你認(rèn)為很難的技術(shù)研發(fā)工作在短時(shí)間內(nèi)卻已經(jīng)完成，這都需要留意，并了解實(shí)際狀況。最終通過(guò)計(jì)劃管理說(shuō)明確文檔定是否預(yù)定的目標(biāo)已經(jīng)全部完成。而已經(jīng)完成的內(nèi)容應(yīng)當(dāng)和以上提

5、交的成果說(shuō)明是全都的，此部分假如不存在文檔，就需要依據(jù)相應(yīng)的成果內(nèi)容及人員對(duì)整個(gè)過(guò)程進(jìn)行文檔補(bǔ)充。此文檔完成后，也可成為后續(xù)管理的一個(gè)基礎(chǔ)，進(jìn)行優(yōu)化處理。 假如沒(méi)有計(jì)劃管理文檔的話，補(bǔ)充的時(shí)候，則建議采用Project來(lái)完成，前一個(gè)成果提交文檔，并且最好可以采用WBS來(lái)組織任務(wù)的支配，將已經(jīng)提交的對(duì)應(yīng)到相應(yīng)的任務(wù)中。通過(guò)前一文檔狀態(tài)的說(shuō)明，將未完成的內(nèi)容做標(biāo)記，并且看是否存在同樣的任務(wù)不同的成果表現(xiàn)形式的狀況，這時(shí)應(yīng)當(dāng)是屬于重復(fù)性任務(wù)，也做標(biāo)記說(shuō)明。 三、需求說(shuō)明書(shū)：需說(shuō)明產(chǎn)品的最初需求內(nèi)容實(shí)際對(duì)于我當(dāng)前接手的這個(gè)產(chǎn)品，需求說(shuō)明書(shū)的重要性已經(jīng)大大降低了，因?yàn)楫a(chǎn)品已經(jīng)研發(fā)完成，且供應(yīng)了完整的用戶

6、手冊(cè)，但整理需求說(shuō)明書(shū)的主要目的還是有兩個(gè)： 1、是要建立完整的項(xiàng)目過(guò)程追溯流程，為后續(xù)工作做預(yù)備。 2、通過(guò)需求驗(yàn)證成果的有效及可用性。 需求說(shuō)明書(shū)是一個(gè)可簡(jiǎn)可繁的一個(gè)文檔，在這個(gè)項(xiàng)目中，需求說(shuō)明書(shū)更多的是從用戶手冊(cè)中來(lái)提取需求了，實(shí)際的意義并不是很大。但假如是做一個(gè)新的項(xiàng)目，則需求說(shuō)明書(shū)應(yīng)當(dāng)是僅最大可能的對(duì)用戶業(yè)務(wù)進(jìn)行一種還原描述，不要摻雜個(gè)人的理解。至于是否可以實(shí)現(xiàn)，怎么實(shí)現(xiàn)是后續(xù)工作的事情，不是這個(gè)環(huán)節(jié)的內(nèi)容。 四、系統(tǒng)設(shè)計(jì)說(shuō)明書(shū)：系統(tǒng)設(shè)計(jì)說(shuō)明書(shū)現(xiàn)在在這個(gè)時(shí)候已經(jīng)無(wú)法在考慮設(shè)計(jì)的問(wèn)題，但此時(shí)應(yīng)當(dāng)供應(yīng)以下內(nèi)容： 1、系統(tǒng)的架構(gòu)設(shè)計(jì)及架構(gòu)在應(yīng)用過(guò)程的調(diào)整。并且最好可以供應(yīng)架構(gòu)的弊病分析說(shuō)明

7、。 2、接口設(shè)計(jì)說(shuō)明及接口的具體規(guī)格及設(shè)計(jì)說(shuō)明?，F(xiàn)在的系統(tǒng)基本上都是松散的，通過(guò)接口標(biāo)準(zhǔn)從而最終實(shí)現(xiàn)系統(tǒng)的集成，所以，接口部分特別關(guān)鍵，這部分內(nèi)容一定要特別清楚和精確。 3、假如現(xiàn)在無(wú)法再供應(yīng)設(shè)計(jì)文檔，則建議通過(guò)第三方工具，依據(jù)成果代碼反項(xiàng)生成設(shè)計(jì)，并在此基礎(chǔ)上進(jìn)行文檔補(bǔ)充，看設(shè)計(jì)總比看代碼好許多，所以，這部分內(nèi)容應(yīng)當(dāng)進(jìn)行供應(yīng)。假如在新項(xiàng)目中，此部分內(nèi)容頁(yè)建議考慮，主要是規(guī)劃接口調(diào)用、對(duì)象職能及對(duì)象關(guān)系。 五、數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū) 我本人還是非常重視數(shù)據(jù)庫(kù)設(shè)計(jì)的，雖 慮，主要是規(guī)劃接口調(diào)用、對(duì)象職能及對(duì)象關(guān)系。 五、數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū) 我本人還是非常重視數(shù)據(jù)庫(kù)設(shè)計(jì)的，雖然現(xiàn)在有許多的DAO的工具，而

8、且也倡導(dǎo)對(duì)象建模，但實(shí)際在應(yīng)用過(guò)程中，完全做到的 的卻是少之又少，尤其是針對(duì)數(shù)據(jù)分析部分內(nèi)容。所以此文檔我認(rèn)為還是特別重要的。至于文檔的格式，因?yàn)榇朔矫嬉呀?jīng)特別“標(biāo)準(zhǔn)”化了，就不在進(jìn)行說(shuō)明白。 六、測(cè)試報(bào)告 這個(gè)項(xiàng)目中是不需要了，假如是一個(gè)新的項(xiàng)目則建議由測(cè)試計(jì)劃起進(jìn)行。 基本上就是這么多了，應(yīng)當(dāng)說(shuō)文檔不少，但，是一個(gè)完整的流程，項(xiàng)目最初啟動(dòng)的時(shí)候，應(yīng)當(dāng)建立文檔規(guī)范，文檔不要多，但要可以對(duì)項(xiàng)目的每個(gè)環(huán)節(jié)都有描述說(shuō)明的。我見(jiàn)過(guò)一個(gè)項(xiàng)目光需求說(shuō)明就有許多份不同的文檔，很頭疼，而且后期的維護(hù)也會(huì)很麻煩。建議每個(gè)環(huán)節(jié)就一份統(tǒng)一文檔。制定大家習(xí)慣的閱讀方式（這點(diǎn)很關(guān)鍵，否則大家都不看），由大家共同維護(hù)完

9、成。做一總結(jié)： 需求說(shuō)明文檔：建議先將需求進(jìn)行分解，然后用表格進(jìn)行說(shuō)明。假如條件允許，那就用RequisitePro管理需求，實(shí)現(xiàn)跟蹤。 系統(tǒng)分析設(shè)計(jì)文檔：建議采用Rose，需求用例一定要有，哪怕顆粒度大一些，在需求用例部分進(jìn)行需求分析的說(shuō)明，而且要說(shuō)明規(guī)格要求。組件及類圖一定要有，規(guī)范接口調(diào)用規(guī)則，組織代碼結(jié)構(gòu)，建立良好的系統(tǒng)框架。其中說(shuō)明組件或類職能。此部分不一定完全由設(shè)計(jì)人員完成。有可能的狀況下，供應(yīng)活動(dòng)圖。程序員對(duì)活動(dòng)圖的興趣要高于時(shí)序和狀態(tài)圖?？梢杂肧oDA產(chǎn)生相應(yīng)文檔（只讀）供開(kāi)發(fā)查詢使用。不一定一個(gè)Rose文件，可以多個(gè)，假如要拆分，對(duì)應(yīng)需求拆分。 數(shù)據(jù)庫(kù)說(shuō)明書(shū)：建議用PD，然后自動(dòng)生成文檔（只讀），供開(kāi)發(fā)查詢使用。 測(cè)試報(bào)告：可以用測(cè)試報(bào)告對(duì)成果進(jìn)行說(shuō)