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

字號:

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