關(guān)于軟件工程血的教訓(xùn)之文檔管理

字號(hào):

文檔管理混亂是上個(gè)項(xiàng)目最為致命和混亂的,我個(gè)人認(rèn)為,如果一個(gè)項(xiàng)目小組進(jìn)行開(kāi)發(fā)一個(gè)系統(tǒng)的時(shí)候沒(méi)有文檔的開(kāi)發(fā)個(gè)人認(rèn)為是可怕的,而在系統(tǒng)的開(kāi)發(fā)中沒(méi)有對(duì)文檔進(jìn)行有效管理是恐怖的,我們要做的是一個(gè)產(chǎn)品,而不是自?shī)首詷?lè)的一個(gè)試驗(yàn)品,作為產(chǎn)品,必須要標(biāo)準(zhǔn),無(wú)論是客戶給我們的標(biāo)準(zhǔn)還是開(kāi)發(fā)小組給自己的標(biāo)準(zhǔn),關(guān)于標(biāo)準(zhǔn)將在后面做詳細(xì)討論。而有標(biāo)準(zhǔn)就必要有相關(guān)的文檔,關(guān)于文檔的好處大家都清除,無(wú)論在軟件開(kāi)發(fā)部署以及維護(hù)的任何階段它都扮演著很重要的角色,關(guān)于文檔我覺(jué)得它不是形式一個(gè)開(kāi)發(fā)小組的負(fù)責(zé)人對(duì)文檔的態(tài)度就覺(jué)得樂(lè)這個(gè)系統(tǒng)的成?。ㄕf(shuō)的夸張些)。
     除了認(rèn)真做各個(gè)階段的相關(guān)文檔外,還要對(duì)文檔進(jìn)行有效管理,下面將說(shuō)一下這幾年來(lái)對(duì)文檔管理的一些開(kāi)發(fā),僅僅是拋磚引玉,歡迎大家補(bǔ)充和牌磚。
     1 、文檔必須需要版本。
     像軟件一樣,如果不對(duì)文檔進(jìn)行版本管理和控制,文檔的修改將造成文檔的混亂,尤其是比較大的項(xiàng)目,一定對(duì)文檔的管理進(jìn)行版本控制,不然每次文檔修改,想找到什么時(shí)候做樂(lè)什么修改,為什么做這次的修改都搞不清楚,后面的程序員的工作就很難開(kāi)展。
     2、文檔需要專(zhuān)人負(fù)責(zé)。
     如果一個(gè)小組的人手足夠多的話,希望能有一個(gè)人來(lái)專(zhuān)門(mén)負(fù)責(zé)對(duì)文檔管理,如果開(kāi)發(fā)小組的人手緊張需小組某一個(gè)人簡(jiǎn)直負(fù)責(zé),不能每個(gè)人都隨意的對(duì)所有的文檔都拿來(lái)拿去。
     3、文檔的修改要有嚴(yán)格的章程控制。
     文檔一旦形成,不能隨意修改,當(dāng)然形成正式版本的文檔之前一定要認(rèn)真討論確定文檔,一旦文檔確定后,不能隨意修改,尤其是前期文檔,如需求分析,需求分析一變后面的設(shè)計(jì)文檔都要變,這樣變來(lái)變?nèi)?huì)影響到系統(tǒng)的整體進(jìn)度與軟件的質(zhì)量。每次修改都要做好記錄為什么要做這個(gè)修改,修改樂(lè)哪些部分 會(huì)影響到哪些文檔一定要注明還要包括文檔修改的發(fā)起人和批準(zhǔn)人。
     4 、文檔的份數(shù)。
     個(gè)人認(rèn)為一個(gè)十人以內(nèi)的開(kāi)發(fā)小組每個(gè)版本的文檔只需要一份,尤其是開(kāi)發(fā)階段流傳在程序員手中的文檔盡量只有一份,大家以互相傳閱的方式進(jìn)行查閱文檔,并不是每個(gè)人一份文檔會(huì)給項(xiàng)目的進(jìn)度帶來(lái)有利的影響,上一個(gè)項(xiàng)目中每次文檔修改后,都給每個(gè)人打印一份近千頁(yè)的文檔,一是造成了巨大的浪費(fèi),二是由于沒(méi)有對(duì)版本控制好,每個(gè)人手里的文檔不止一份,開(kāi)始的時(shí)候大家還比較清楚到最后,大家都快搞不清應(yīng)該以哪一份文檔為準(zhǔn)了。