1、項(xiàng)目文檔管理方案項(xiàng)目組2010-1目 錄一, 文件種類3二，使用文件的人員以及所關(guān)心的文件：4三，軟件生存周期各個(gè)階段及其相應(yīng)的各種文件的編制6四，文件編制工作的管理7五,附:目錄結(jié)構(gòu)說明11一, 文件種類在一項(xiàng)軟件系統(tǒng)的開發(fā)過程中，一般地說，應(yīng)該產(chǎn)生以下多種文件：0配置及材料1項(xiàng)目任務(wù)書2項(xiàng)目計(jì)劃書及評(píng)審總結(jié)報(bào)告3系統(tǒng)開發(fā)計(jì)劃文檔04需求說明書及評(píng)審報(bào)告系統(tǒng)設(shè)計(jì)4.1接口設(shè)計(jì)4.2軟件設(shè)計(jì)總體設(shè)計(jì)說明書詳細(xì)設(shè)計(jì)說明書數(shù)據(jù)庫設(shè)計(jì)說明書7系統(tǒng)測試及測試評(píng)審報(bào)告測試申請(qǐng)測試報(bào)告測試總結(jié)測試評(píng)審表8系統(tǒng)實(shí)施(割接)方案9系統(tǒng)試運(yùn)行10系統(tǒng)總結(jié)11驗(yàn)收表12系統(tǒng)版本維護(hù)13系統(tǒng)維護(hù)手冊(cè)/系統(tǒng)使用(操作

2、)手冊(cè)培訓(xùn)文檔14系統(tǒng)故障/維護(hù)申請(qǐng)紀(jì)錄 15項(xiàng)目會(huì)議紀(jì)要周(月)報(bào)項(xiàng)目會(huì)議紀(jì)錄二，使用文件的人員以及所關(guān)心的文件：人員文件種類人員名單管理人員配置及材料項(xiàng)目任務(wù)書項(xiàng)目計(jì)劃書及評(píng)審總結(jié)報(bào)告系統(tǒng)開發(fā)計(jì)劃文檔項(xiàng)目會(huì)議紀(jì)要系統(tǒng)實(shí)施(割接)方案系統(tǒng)試運(yùn)行系統(tǒng)總結(jié)驗(yàn)收表開發(fā)人員0配置及材料1項(xiàng)目任務(wù)書2項(xiàng)目計(jì)劃書及評(píng)審總結(jié)報(bào)告3系統(tǒng)開發(fā)計(jì)劃文檔04系統(tǒng)設(shè)計(jì)5需求說明書及評(píng)審報(bào)告06系統(tǒng)開發(fā)計(jì)劃文檔7系統(tǒng)測試及測試評(píng)審報(bào)告8系統(tǒng)實(shí)施(割接)方案9系統(tǒng)試運(yùn)行測試人員項(xiàng)目開發(fā)計(jì)劃軟件需求說明書系統(tǒng)設(shè)計(jì)系統(tǒng)測試維護(hù)人員系統(tǒng)版本維護(hù)系統(tǒng)設(shè)計(jì)測試分析報(bào)告用戶維護(hù)手冊(cè)操作手冊(cè)三，軟件生存周期各個(gè)階段及其相應(yīng)的各種文件

3、的編制3.1 軟件生存周期一個(gè)計(jì)算機(jī)軟件，從出現(xiàn)構(gòu)思，經(jīng)過開發(fā)成功并投入使用，到停止使用，完成一個(gè)生存周期。這個(gè)周期可以分為6個(gè)階段：- 可行性與計(jì)劃研究階段- 需求分析階段- 設(shè)計(jì)階段- 實(shí)現(xiàn)階段- 測試階段- 運(yùn)行與維護(hù)階段3.2 軟件生存周期各階段中各類文件的編制階段文件可行性研究與計(jì)劃階段 需求分析階段設(shè)計(jì)階段實(shí)現(xiàn)階段測試階段運(yùn)行與維護(hù)階段可行性研究報(bào)告 項(xiàng)目開發(fā)計(jì)劃 軟件需求說明書 開發(fā)計(jì)劃 測試計(jì)劃 概要設(shè)計(jì)說明書 詳細(xì)設(shè)計(jì)說明書 數(shù)據(jù)庫設(shè)計(jì)說明書 系統(tǒng)實(shí)施(割接)方案系統(tǒng)試運(yùn)行報(bào)告用戶手冊(cè) 操作手冊(cè) 測試分析報(bào)告開發(fā)進(jìn)度月報(bào)項(xiàng)目開發(fā)總結(jié)四，文件編制工作的管理文件編制工作必須有管理

4、工作的配合，才能使所編制的文件真正發(fā)揮作用。文件編制工作是一項(xiàng)貫穿整個(gè)軟件開發(fā)過程的工作。因此對(duì)文件的管理必須貫徹整個(gè)開發(fā)過程。在開發(fā)中必須進(jìn)行的管理工作有：4.1文件的形成文件的形成是各個(gè)階段開發(fā)工作正式完成的標(biāo)志，因此，開發(fā)集體必須及時(shí)地對(duì)這些文件進(jìn)行嚴(yán)格的評(píng)審。在軟件開發(fā)過程中，必須- 按照規(guī)定，及時(shí)完成各種產(chǎn)品文件的編寫工作；- 將開發(fā)過程中做出的決定和取得的修改及時(shí)寫入文件；文件中必須有文件創(chuàng)建者，修改者的簽字及日期，必要的文件需要填寫評(píng)審者、批準(zhǔn)者的簽字及編寫、評(píng)審?fù)瓿傻娜掌诤团鷾?zhǔn)日期。4.2文件分類與標(biāo)識(shí)為了便于文件的保存、查找、使用和修改，應(yīng)該對(duì)文件按照層次加以分類組織。可以按

5、照如下4個(gè)層次對(duì)文件加以分類和標(biāo)識(shí)。a 文件編號(hào)b 文件所屬項(xiàng)目標(biāo)識(shí)c 文件種類標(biāo)識(shí)d 每一種文件的不同版本號(hào)4.3文件的控制在軟件開發(fā)過程中，隨著程序的逐步形成和逐步修改，各種文件不斷產(chǎn)生、修改和補(bǔ)充。因此，必須加以周密的控制，以保證文件與程序產(chǎn)品的一致性，保證文件之間的一致性和安全性。這種控制表現(xiàn)為：(i).對(duì)于一項(xiàng)軟件開發(fā)工作，應(yīng)設(shè)置一位專職的文件管理人員（可以由項(xiàng)目管理工程師擔(dān)當(dāng)，也可以由專門的文檔管理員擔(dān)當(dāng)）。(ii). 每一份提交給文件管理人員的文件都必須有編寫者、編寫日期。(iii). 開發(fā)集體中的工作人員可以根據(jù)工作的需要，在本項(xiàng)目的開發(fā)過程中持有一些文件，即所謂個(gè)人文件，包括

6、為使他完成他承擔(dān)的任務(wù)所需要的文件，以及他在完成任務(wù)過程中所編制的文件；該類文件須定期提交文件管理人員。(iv). 不同開發(fā)人員所擁有的個(gè)人文件通常是主文本的各種子集。所謂子集是主文本的各個(gè)部分根據(jù)所承擔(dān)不同任務(wù)的人員的工作需要加以復(fù)制、組裝而成的若干個(gè)文件的集合。文件管理人員應(yīng)列出一份不同子集的分發(fā)對(duì)象的清單，按照清單及時(shí)把文件分發(fā)給有關(guān)的人員。(v). 一份文件如果已被另一份新的文件所代替，則原文件應(yīng)該被注銷。文件管理人員應(yīng)該隨時(shí)整理主文本，及時(shí)反映出文件的變化和增加情況。(vi). 當(dāng)一個(gè)項(xiàng)目的開發(fā)工作臨近結(jié)束時(shí)，文件管理人員應(yīng)該逐個(gè)收回開發(fā)集體內(nèi)每個(gè)成員的個(gè)人文件，并檢查這些個(gè)人文件的

7、內(nèi)容。如果發(fā)現(xiàn)這些個(gè)人文件比主文本更加詳細(xì)，或不同于主文本，文件管理人員應(yīng)監(jiān)督有關(guān)人員進(jìn)行修改，使主文本能真正反映出實(shí)際的開發(fā)結(jié)果。4.4文檔的修改管理在開發(fā)過程中，開發(fā)集體內(nèi)的任何成員對(duì)文件的修改都應(yīng)該遵守以下規(guī)程：(i). 提議 開發(fā)集體中的任何一個(gè)成員都可以向項(xiàng)目負(fù)責(zé)人提出修改建議，為此應(yīng)該填寫一份修改建議表，說明修改的內(nèi)容、所修改的文件和部位、以及修改理由。(ii). 評(píng)議 有項(xiàng)目負(fù)責(zé)人或項(xiàng)目負(fù)責(zé)人指定的人對(duì)該修改建議進(jìn)行評(píng)議，包括審核該修改的必要性，確定這一修改的影響范圍，研究進(jìn)行修改的方法、步驟和實(shí)施計(jì)劃。(iii). 審核 由項(xiàng)目負(fù)責(zé)人進(jìn)行審核，包括核實(shí)修改的目的和要求，核實(shí)修改或定將帶來的影響，審核修改或定是否可行。(iv). 批準(zhǔn) 由開發(fā)單位的部門負(fù)責(zé)人或上級(jí)領(lǐng)導(dǎo)對(duì)修改計(jì)劃進(jìn)行批準(zhǔn)。批準(zhǔn)時(shí)，主要是決斷修改工作的各項(xiàng)活動(dòng)的先后順序及各自的完成日期