【正文】 ISO9001質(zhì)量體系作業(yè)文件 名 稱 ： 軟件開發(fā)技術(shù)文檔管理規(guī)范 編 號(hào) ： 版號(hào) 擬 制 ： 日期 審 核 ： 日期 批 準(zhǔn) ： 日期 生效日期 ： 受控狀態(tài) ： 發(fā)文號(hào) ： 會(huì)簽部門 會(huì)簽人 /日期 會(huì)簽部門 會(huì) 簽人 /日期 軟件開發(fā)技術(shù)文檔管理規(guī)范 第 1頁 共 59頁 目錄 1. 前言 .........................................................................................................................................................1 目的 ............................................................................................................................................1 術(shù)語 ............................................................................................................................................1 參考文獻(xiàn) ...................................................................................................................................1 版本說明和修改歷史 ...............................................................................................................1 2. 軟件文檔 .................................................................................................................................................1 文檔的定義及作用 ...................................................................................................................1 軟件文檔的分類 .......................................................................................................................2 軟件文檔的制作與軟件生存周期之間的關(guān)系 .....................................................................3 文檔的使用者 ...........................................................................................................................3 3. 文檔編制格式規(guī)范 ................................................................................................................................4 文檔編碼規(guī)則 ...........................................................................................................................4 文檔組成格式 ...........................................................................................................................4 封面 ...............................................................................................................................5 目錄 ...............................................................................................................................6 版本更新說明 ..............................................................................................................6 文件內(nèi)容 ......................................................................................................................6 正文格式 ......................................................................................................................7 文檔制作工具 ...........................................................................................................................7 4. 文檔管理規(guī)范 ........................................................................................................................................7 文檔管理崗位職責(zé) ...................................................................................................................7 文檔的制作 ...............................................................................................................................8 文檔的分類、編碼與標(biāo) 識(shí) .........................................................................................8 文檔的作者、修改者和打字者 .................................................................................8 文檔的收集 ...............................................................................................................................8 文檔的配置 ...............................................................................................................................9 文檔的控制 ...............................................................................................................................9 文檔的修改管理 .......................................................................................................................9 文檔的借閱和復(fù)制管理制度 ............................................................................................... 10 文檔的保密性 ........................................................................................................................ 10 5. 技術(shù)文檔的質(zhì)量評(píng)價(jià) ..........................................................................................................................11 軟件開發(fā)技術(shù)文檔管理規(guī)范 第 1頁 共 59頁 1. 前言 目的 軟件開發(fā)的不同階段都會(huì)產(chǎn)生大量的文檔。為了加強(qiáng)管理、提高工作效率，充分借鑒前人的經(jīng)驗(yàn)，對(duì)文檔進(jìn)行規(guī)范化管理是很有必要的。它對(duì)于保管在開發(fā)中形成的文檔，為公司積累寶貴的技術(shù)知識(shí)的財(cái)富，為今后的軟件開發(fā)工作提供第一手的寶 貴資料起著重要的作用。 為了規(guī)范創(chuàng)智集團(tuán)工程項(xiàng)目的開發(fā)工作，根據(jù)國(guó)家標(biāo)準(zhǔn)局制定的有關(guān)軟件開發(fā)和開發(fā)文件的規(guī)范標(biāo)準(zhǔn)，結(jié)合公司的實(shí)際，制定本規(guī)范。 術(shù)語 略。 參考文獻(xiàn) 1) 《 1998 計(jì)算機(jī)軟件工程規(guī)范 國(guó)家標(biāo)準(zhǔn)》 中國(guó)標(biāo)準(zhǔn)出版社 1998 年6 月第一版。 2) 《軟件工程概論》 鄭人杰等 清華大學(xué)出版社 1998 年 4 月第一版。 3) 《實(shí)用軟件工程》 鄭人杰等 清華大學(xué)出版社 1997 年 4 月第二版。 4) 《創(chuàng)智軟件園文檔管理規(guī)范》 創(chuàng)智（湖南）軟件園有限公司 1996 年5 月。 5) 《創(chuàng)智軟件園軟件開 發(fā)管理規(guī)范》 創(chuàng)智（湖南）軟件園有限公司 1995年 12 月。 版本說明和修改歷史 本規(guī)范是在公司原有文檔規(guī)范的基礎(chǔ)上，于 1999 年 05 月份修訂而成，具體的修訂人員為孫繼綱、趙海等。 2. 軟件文檔 文檔的定義及作用 文檔（ document）是指某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。它具有永久性，軟件開發(fā)技術(shù)文檔管理規(guī)范 第 2頁 共 59頁 并可以由人或機(jī)器閱讀，通常僅用于描述人工可讀的東西。 正確地制作和使用軟件文檔，可以獲得如下的便利： ? 提高軟件開發(fā)過程的能見度。 ? 提高開發(fā)效率。 ? 作為開發(fā)人員在一定階段的工作成果和結(jié)束標(biāo)志。 ? 記錄開發(fā)過程中的有關(guān)信息 ，便于協(xié)調(diào)以后的軟件、開發(fā)、使用和維護(hù)。 ? 便于潛在用戶了解軟件的功能、性能等各項(xiàng)指標(biāo)，為他們選購(gòu)符合自己需要的軟件提供依據(jù)。 軟件文檔的分類 對(duì)于軟件文檔的分類有多種方法。 從形式上分為兩類： ? 開發(fā)過程中可以填寫的各種圖表，可稱之為工作表格。 ? 應(yīng)編制的技術(shù)資料或技術(shù)管理資料，可稱之為文檔或文件。 按照軟件文檔的產(chǎn)生和使用范圍可以分為三類： ? 開發(fā)文檔：軟件開發(fā)過程中，作為軟件開發(fā)人員前一階段工作成果的體現(xiàn)和后一階段工作依據(jù)的文檔。包括可行性研究、項(xiàng)目開發(fā)計(jì)劃、需求說明、數(shù)據(jù)說明、概要設(shè)計(jì)和詳細(xì)設(shè)計(jì)。 ? 管理文檔 ：軟件開發(fā)過程中，由軟件開發(fā)人員制定的需提交管理人員的一些工作計(jì)劃和工作報(bào)告，包括項(xiàng)目開發(fā)計(jì)劃、測(cè)試計(jì)劃、測(cè)試報(bào)告、開發(fā)進(jìn)度月報(bào)及項(xiàng)目開發(fā)總結(jié)。 ? 用戶文檔：軟件開發(fā)人員為用戶準(zhǔn)備的有關(guān)該軟件使用、操作、維護(hù)的資料，包括用戶手冊(cè)、操作手冊(cè)、維護(hù)修改建議、需求說明。 按照計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南的國(guó)家標(biāo)準(zhǔn)（ GB856788）的要求，在一項(xiàng)計(jì)算機(jī)軟件的開發(fā)過程中，一般地說，應(yīng)該產(chǎn)生 14 種文件： ? 可行性研究報(bào)告。 ? 項(xiàng)目開發(fā)計(jì)劃。 ? 軟件需求說明書。 ? 數(shù)據(jù)要求說明書。 ? 概要設(shè)計(jì)說明書。 ? 詳