014軟件開(kāi)發(fā)技術(shù)管理規(guī)范

側(cè)石混凝擋墻分ISO9001質(zhì)量體系作文件名編擬審批

稱(chēng)：號(hào)：制：核：準(zhǔn)：

軟件開(kāi)發(fā)技文檔管理規(guī)版號(hào)日日日生日：受狀：會(huì)簽部門(mén)

會(huì)簽人/日期

發(fā)號(hào)：會(huì)簽部門(mén)

會(huì)簽人/日期腳容

側(cè)石混凝擋墻分目錄1.

前

目的1術(shù)語(yǔ)1參考文獻(xiàn)1版本說(shuō)明和改歷史12.

軟文

文檔的定義作用1軟件文檔的類(lèi)軟件文檔的作與軟件存周期之的關(guān)系文檔的使用33.

文編格規(guī)

文檔編碼規(guī)4文檔組成格4封目版本更新說(shuō)文件內(nèi)正文格文檔制作工74.

文管規(guī)

文檔管理崗職責(zé)7文檔的制作7文檔的分類(lèi)、編碼與標(biāo)文檔的作者、修改者和打字文檔的收集8文檔的配置8文檔的控制8文檔的修改理文檔的借閱復(fù)制管理度9文檔的保密95.

技文的量?jī)r(jià)1腳容

側(cè)石混凝擋墻分前言1.1目的軟件開(kāi)發(fā)的不同階段都會(huì)產(chǎn)生大量的文檔。為了加強(qiáng)管理、提高工作效率，充分借鑒前人的經(jīng)驗(yàn)對(duì)文檔進(jìn)行規(guī)范化管理是很有必要的它對(duì)于保管在開(kāi)發(fā)中形成的文檔為公司積累寶貴的技術(shù)知識(shí)的財(cái)富為今后的軟件開(kāi)發(fā)工作提供第一手的寶貴資料起著重要的作用。為了規(guī)范創(chuàng)智集團(tuán)工程項(xiàng)目的開(kāi)發(fā)工作據(jù)國(guó)家標(biāo)準(zhǔn)局制定的有關(guān)軟件開(kāi)發(fā)和開(kāi)發(fā)文件的規(guī)范標(biāo)準(zhǔn)，結(jié)合公司的實(shí)際，制定本規(guī)范。1.2術(shù)語(yǔ)略。1.3參考文獻(xiàn)1)2)3)4)5)

《1998計(jì)算機(jī)軟件工程規(guī)范----國(guó)家標(biāo)準(zhǔn)》中國(guó)標(biāo)準(zhǔn)出版社1998年6第一版。《軟件工程概論》鄭人杰等清華大學(xué)出版社19984月第一版。《實(shí)用軟件工程》鄭人杰等清華大學(xué)出版社19974月第二版?！秳?chuàng)智軟件園文檔管理規(guī)范》創(chuàng)智（湖南）軟件園有限公司19965?！秳?chuàng)智軟件園軟件開(kāi)發(fā)管理規(guī)范》創(chuàng)（湖南軟件園有限公司1995年12。1.4版本說(shuō)明和修歷史本規(guī)范是在公司原有文檔規(guī)范的基礎(chǔ)上，于年月份修訂而成，具體的修訂人員為孫繼綱、趙海等。軟件文檔2.1文檔的定義及用文檔（document）是指某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。它具有永久性，腳容

側(cè)石混凝擋墻分并可以由人或機(jī)器閱讀，通常僅用于描述人工可讀的東西。正確地制作和使用軟件文檔，可以獲得如下的便利：提高軟件開(kāi)發(fā)過(guò)程的能見(jiàn)度。提高開(kāi)發(fā)效率。作為開(kāi)發(fā)人員在一定階段的工作成果和結(jié)束標(biāo)志。記錄開(kāi)發(fā)過(guò)程中的有關(guān)信息，便于協(xié)調(diào)以后的軟件、開(kāi)發(fā)、使用和維護(hù)。便于潛在用戶(hù)了解軟件的功能、性能等各項(xiàng)指標(biāo)，為他們選購(gòu)符合自己需要的軟件提供依據(jù)。2.2軟件文檔的分對(duì)于軟件文檔的分類(lèi)有多種方法。從形式上分為兩類(lèi)：開(kāi)發(fā)過(guò)程中可以填寫(xiě)的各種圖表，可稱(chēng)之為工作表格。應(yīng)編制的技術(shù)資料或技術(shù)管理資料，可稱(chēng)之為文檔或文件。按照軟件文檔的產(chǎn)生和使用范圍可以分為三類(lèi)：開(kāi)發(fā)文檔：軟件開(kāi)發(fā)過(guò)程中，作為軟件開(kāi)發(fā)人員前一階段工作成果的體現(xiàn)和后一階段工作依據(jù)的文檔。包括可行性研究、項(xiàng)目開(kāi)發(fā)計(jì)劃、需求說(shuō)明、數(shù)據(jù)說(shuō)明、概要設(shè)計(jì)和詳細(xì)設(shè)計(jì)。管理文檔：軟件開(kāi)發(fā)過(guò)程中，由軟件開(kāi)發(fā)人員制定的需提交管理人員的一些工作計(jì)劃和工作報(bào)告，包括項(xiàng)目開(kāi)發(fā)計(jì)劃、測(cè)試計(jì)劃、測(cè)試報(bào)告、開(kāi)發(fā)進(jìn)度月報(bào)及項(xiàng)目開(kāi)發(fā)總結(jié)。用戶(hù)文檔：軟件開(kāi)發(fā)人員為用戶(hù)準(zhǔn)備的有關(guān)該軟件使用、操作、維護(hù)的資料，包括用戶(hù)手冊(cè)、操作手冊(cè)、維護(hù)修改建議、需求說(shuō)明。按照計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文件編制指南的國(guó)家標(biāo)準(zhǔn)（GB8567-88）的要求，在一項(xiàng)計(jì)算機(jī)軟件的開(kāi)發(fā)過(guò)程中，一般地說(shuō)，應(yīng)該產(chǎn)生種文件：可行性研究報(bào)告。項(xiàng)目開(kāi)發(fā)計(jì)劃。軟件需求說(shuō)明書(shū)。數(shù)據(jù)要求說(shuō)明書(shū)。概要設(shè)計(jì)說(shuō)明書(shū)。詳細(xì)設(shè)計(jì)說(shuō)明書(shū)。數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)。用戶(hù)手冊(cè)。操作手冊(cè)。模塊開(kāi)發(fā)卷宗。測(cè)試計(jì)劃。測(cè)試分析報(bào)告。開(kāi)發(fā)進(jìn)度月報(bào)。項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告。腳容

側(cè)石混凝擋墻分2.3軟件文檔的制與軟件生存周之間的關(guān)系一般而言，計(jì)算機(jī)軟件生存周期可以分為六個(gè)階段：可行性與計(jì)劃研究階段。需求分析階段。設(shè)計(jì)階段。實(shí)現(xiàn)階段。測(cè)試階段。運(yùn)行與維護(hù)階段。在軟件開(kāi)發(fā)的不同階段產(chǎn)生的軟件文檔不同具體對(duì)應(yīng)關(guān)系如下表所示。階段可行性研究與計(jì)劃需求分設(shè)計(jì)實(shí)現(xiàn)測(cè)試運(yùn)行與維文檔可行性研究報(bào)告項(xiàng)目開(kāi)發(fā)計(jì)劃軟件需求說(shuō)明書(shū)數(shù)據(jù)要求說(shuō)明書(shū)測(cè)試計(jì)劃概要設(shè)計(jì)說(shuō)明書(shū)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)模塊開(kāi)發(fā)卷宗用戶(hù)手冊(cè)操作手冊(cè)測(cè)試分析報(bào)告開(kāi)發(fā)進(jìn)度月報(bào)項(xiàng)目開(kāi)發(fā)總結(jié)2.4文檔的使用者

階段析階段階段階段階段護(hù)階段對(duì)于軟件文檔的使用人員而言與其所承擔(dān)的工作有關(guān)具體情況如下所示。管理人員：可行性研究報(bào)告。項(xiàng)目開(kāi)發(fā)計(jì)劃書(shū)。模塊開(kāi)發(fā)卷宗。開(kāi)發(fā)進(jìn)度月報(bào)。項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告。開(kāi)發(fā)人員：可行性研究報(bào)告。項(xiàng)目開(kāi)發(fā)計(jì)劃書(shū)。需求分析說(shuō)明書(shū)。概要設(shè)計(jì)說(shuō)明書(shū)腳容

維護(hù)人員：最終用戶(hù)：

側(cè)石混凝擋墻分詳細(xì)設(shè)計(jì)說(shuō)明書(shū)數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)。測(cè)試計(jì)劃。測(cè)試分析報(bào)告。設(shè)計(jì)說(shuō)明書(shū)。測(cè)試分析報(bào)告。模塊開(kāi)發(fā)卷宗。系統(tǒng)安裝手冊(cè)。用戶(hù)手冊(cè)。系統(tǒng)維護(hù)手冊(cè)。系統(tǒng)功能說(shuō)明書(shū)文檔編制格式規(guī)范3.1文檔編碼規(guī)則公司所有的技術(shù)文檔，都必須具有一個(gè)唯一的系列號(hào)，格式為：PRS-PID-XX：1)“PRS創(chuàng)智標(biāo)識(shí)符（CompanyFlag)。2)“PID項(xiàng)目代號(hào)。3)“XX檔標(biāo)識(shí)號(hào)，參見(jiàn)《軟件開(kāi)發(fā)配置管理規(guī)程例如，文件號(hào)：PRS-PowerOffice-MD-01-1.0.0表示：該文件由本公司產(chǎn)品PowerOffice，MD表示是管理文檔，001表示是項(xiàng)目開(kāi)發(fā)計(jì)劃書(shū)，版本號(hào)1.0.0表示是PowerOffice品1.0.0版。3.2文檔組成格式公司所有文檔（僅一頁(yè)的文件可按單頁(yè)文檔格式組織）由封面、目錄ContentTable)、版本更新說(shuō)明書(shū)（Rivision)、文件內(nèi)容等組成，如圖所示圖文組檔封面封面組成可劃分為：1.文檔號(hào)：DOC.NO.文檔系列號(hào)(文檔文名)字體:Arial,小四,加粗腳容

例側(cè)石混凝擋墻分例：DOC.NO.PRS-PID-XX(Facedoc.doc)例2.項(xiàng)目名:中文字體黑體,三號(hào)字體,加粗英文字體:Arial,三號(hào)字體,加粗創(chuàng)智文檔范3.文檔名:

中文字體：黑體一號(hào)字體,加粗英文字體：Arial,一號(hào)字體,加粗工程技術(shù)目文檔規(guī)范例：4.密級(jí)英文字體:Arial,小四字體,加粗劃分為五類(lèi)，采用下列關(guān)鍵詞TopConfidentialHighConfidentialConfidentialNormalGeneralTopConfidential絕密產(chǎn)品文檔HighConfidential機(jī)密規(guī)范、指南Confidential秘密計(jì)劃、管理Normal普通工作崗位有關(guān)General明文可以在社會(huì)上廣為流傳例:Normal5.版本號(hào)：關(guān)鍵詞為Version用字體,大小為小四號(hào)例:VersionV1.0.06.完成日：用Arial字體大小為小四號(hào)例:1994.11.14.7.作者WrittenBy……用Arial字體,大小為小四號(hào),加粗例:WrittenPOWERISE8.公司LOGO:用USABLack字體,大小為四號(hào)加粗。例:POWERISE9.公司名及版權(quán)效年份關(guān)鍵詞為：創(chuàng)智軟件園有限公司PoweriseSoftware.Inc.版權(quán)生效年限：關(guān)鍵詞為（C）公歷年號(hào)中文字體:黑體,四號(hào),加粗例:創(chuàng)智軟件園有限公司(C)1994,1999注：此填寫(xiě)產(chǎn)品已經(jīng)過(guò)的份，如PowerLCMS,copyrights(C)1996,1998.英文字體:Arial,四號(hào),加粗腳容

側(cè)石混凝擋墻分例:PoweriseSoftware.Inc.(C)1994,199510.版權(quán)申：字體為Arial,小四,加粗例:AllRightReserved各項(xiàng)安排如下圖,樣板范例可參見(jiàn)本文檔的封面：目錄可采用手工編制或使用文檔編制MicrosoftWord的自動(dòng)生成目錄的功能產(chǎn)生文檔目錄。版本更說(shuō)明關(guān)鍵詞為Revision容劃分為期(Date)由Reason)新者(Revisor)。(首版可省略該節(jié))文件內(nèi)文件內(nèi)容每一頁(yè)必須包含下列三項(xiàng)，缺一不可：頁(yè)首，在頁(yè)首中部自動(dòng)填入‘標(biāo)題’的名稱(chēng)。頁(yè)腳，在頁(yè)腳左部填入創(chuàng)智標(biāo)徽POWERISE，右部填入頁(yè)號(hào)。正文。如下圖所示，具體設(shè)置可復(fù)制本文作模塊。標(biāo)題Powerise創(chuàng)智（創(chuàng)智標(biāo)image）X正文格標(biāo)題一：宋體、小三、粗體，左對(duì)齊；標(biāo)題二：黑體、四號(hào)、粗體，左對(duì)齊；標(biāo)題三：宋體、小四號(hào)、粗體，左對(duì)齊；標(biāo)題四：黑體、小四號(hào)、正常體，左對(duì)齊；標(biāo)題五：黑體、五號(hào)、粗體，左對(duì)齊；腳容

側(cè)石混凝擋墻分正文：宋體、小四號(hào)、正常體，左對(duì)齊。以上行距為單倍行距。3.3文檔制作工具使用何種文檔制作工具原則上沒(méi)有限制但必需考慮到文檔交流的方便性問(wèn)題因此如果在文檔的交流方面因?yàn)槲臋n制作工具的使用差異造成工作上的不便，文檔制作者本人應(yīng)該設(shè)法解決。用于交流和上交的文檔登記說(shuō)明上，應(yīng)注明所使用的文檔制作工具。文檔管理規(guī)范4.1文檔管理崗位責(zé)產(chǎn)生文檔的單位包括：開(kāi)發(fā)部的項(xiàng)目組和配置測(cè)試中心的配置測(cè)試組。項(xiàng)目組的職責(zé)：編寫(xiě)開(kāi)發(fā)計(jì)劃書(shū)，評(píng)/審查通過(guò)后，向配置測(cè)試組提交，進(jìn)入配置管理。編寫(xiě)階段開(kāi)發(fā)計(jì)劃書(shū)、技術(shù)文檔，經(jīng)過(guò)評(píng)/審查后，向配置測(cè)試組提交，進(jìn)入配置管理。編寫(xiě)階段總結(jié)報(bào)告，向配置測(cè)試組提交，進(jìn)入配置管理。配置測(cè)試組的職責(zé)：編寫(xiě)配置測(cè)試評(píng)審計(jì)劃書(shū)，評(píng)審/審查通過(guò)后，進(jìn)入配置管理。編寫(xiě)階段計(jì)劃書(shū)、配置、測(cè)試和評(píng)審文檔，經(jīng)過(guò)評(píng)/審查后，進(jìn)入配置管理。收集項(xiàng)目組的管理文檔和技術(shù)文檔執(zhí)行階段計(jì)劃書(shū)、配置、測(cè)試和評(píng)審，經(jīng)過(guò)評(píng)/審查后，進(jìn)入配置管理。

編寫(xiě)階段總結(jié)報(bào)告，進(jìn)入配置管理。4.2文檔的制作任何軟件開(kāi)發(fā)技術(shù)文檔的作者必須嚴(yán)格按《軟件開(kāi)發(fā)技術(shù)文檔管理規(guī)范》來(lái)制作。技術(shù)文檔的制作可以由作者本人完成，這就要求各開(kāi)發(fā)人員學(xué)習(xí)文檔的制作規(guī)范，按規(guī)范進(jìn)行文檔編寫(xiě)。技術(shù)文檔也可以由作者本人手工書(shū)寫(xiě)，交秘書(shū)來(lái)打字完成，但技術(shù)文檔的作者必須進(jìn)行校對(duì)工作。腳容

側(cè)石混凝擋墻分文檔的類(lèi)、編碼與識(shí)參見(jiàn)《軟件開(kāi)發(fā)配置管理規(guī)程》文檔的者、修改者打字者對(duì)此管理的目的是明確文檔的來(lái)源，使整個(gè)開(kāi)發(fā)的流程清晰可查。以便今后可就某個(gè)技術(shù)細(xì)節(jié)找到相應(yīng)的（作者進(jìn)行更進(jìn)一步的探討和學(xué)習(xí)也便于對(duì)某個(gè)項(xiàng)目的工作任務(wù)作出合理的安排。每本文檔在形成時(shí)，在封面就須寫(xiě)清楚文檔的第一作者及其合作者。如果文檔進(jìn)行了修改、改版，在版本更新說(shuō)明中，還必須寫(xiě)清修改人。在對(duì)文檔進(jìn)行登記歸檔時(shí)也必須如實(shí)記錄作者。其中有第一作者，修改者。同時(shí)記錄打印人和定稿打印的日期。4.3文檔的收集技術(shù)文檔的收集包括2種方式是作者將完成的合乎規(guī)范的技術(shù)文檔主動(dòng)交配置測(cè)試中心關(guān)于本項(xiàng)目指定的配置測(cè)試工程師進(jìn)行配置管理種是配置測(cè)試中心關(guān)于本項(xiàng)目的配置測(cè)試工程師，根據(jù)項(xiàng)目階段任務(wù)和階段成果的安排，在適當(dāng)?shù)臅r(shí)候向相關(guān)的文檔制作者收集技術(shù)文檔，進(jìn)行配置管理和版本控制。4.4文檔的配置與項(xiàng)目有關(guān)的管理文檔和技術(shù)文檔的管理最終統(tǒng)一歸口于軟件配置測(cè)試中心的配置管理組技術(shù)文檔的管理方式是按部門(mén)部門(mén)下面的項(xiàng)目組項(xiàng)目組的不同階段加以配置管理和版本控制例如：以上只是管理的一種形式，它是根據(jù)部門(mén)來(lái)分類(lèi)。另外還可以根據(jù)其它特征來(lái)分類(lèi)。這些特征有時(shí)間、作者、部門(mén)、項(xiàng)目、文檔類(lèi)別等。具體采用什么樣的特征可根據(jù)具體情況進(jìn)行適當(dāng)?shù)姆诸?lèi)。在對(duì)文檔進(jìn)行管理時(shí)必須對(duì)每一份正式的文檔進(jìn)行詳細(xì)的登記登記時(shí)的原則是：手續(xù)嚴(yán)密、格式清晰醒目、簡(jiǎn)化適用、登記項(xiàng)目完整詳盡。這樣在對(duì)文檔進(jìn)行管理時(shí)便于查找文檔和檢查文檔的運(yùn)轉(zhuǎn)情況一般采用簿式登記以便清晰可查。4.5文檔的控制為保持文檔和程序產(chǎn)品的一致性持各種文件之間的一致性和文件的安全性，需要對(duì)文檔進(jìn)行控制，具體表現(xiàn)在：應(yīng)該有文檔管理員集中保管本項(xiàng)目現(xiàn)有全部文檔的主文本兩套，由其負(fù)責(zé)保管腳容

側(cè)石混凝擋墻分每一份提交給文檔管理人員的文檔必需具有編寫(xiě)人、審核人和批準(zhǔn)人的簽字兩套文本的內(nèi)容一致，其中一套可以出借，另一套絕對(duì)不可以出借文檔的借閱和歸還必需有出借和注銷(xiāo)的手續(xù)項(xiàng)目組種的個(gè)人文檔必需和整個(gè)項(xiàng)目的主文檔的內(nèi)容和版本一致一份文檔如果被新文檔更新，原文件必需注銷(xiāo)4.6文檔的修改管在項(xiàng)目開(kāi)發(fā)過(guò)程中，項(xiàng)目組內(nèi)部的任何人都可以提議對(duì)開(kāi)發(fā)工作的文件成果進(jìn)行修改，但必需遵循如下的步驟：提議：項(xiàng)目組內(nèi)部任何一個(gè)人都可以填寫(xiě)修改建議表，提出對(duì)文檔的修改建議評(píng)議：由項(xiàng)目負(fù)責(zé)人或項(xiàng)目負(fù)責(zé)人制定指定的人員對(duì)文檔修改提議進(jìn)行評(píng)議，包括審查該項(xiàng)修改的必要性、影響范圍、研究進(jìn)行修改的方法、步驟和實(shí)施計(jì)劃審核：由項(xiàng)目負(fù)責(zé)人進(jìn)行審核，包括合適修改的目的和要求、核實(shí)修改活動(dòng)將帶來(lái)的影響、審核修改活動(dòng)計(jì)劃是否可行批準(zhǔn)：由開(kāi)發(fā)單位的部門(mén)負(fù)責(zé)人進(jìn)行批準(zhǔn)，主要是決斷修改工作中各項(xiàng)活動(dòng)的先后順序及各自完成日期，以保證整個(gè)開(kāi)發(fā)工作按園丁計(jì)劃日期完成實(shí)施：由項(xiàng)目負(fù)責(zé)人按已批準(zhǔn)的修改活動(dòng)計(jì)劃，安排各項(xiàng)修改活動(dòng)的負(fù)責(zé)人進(jìn)行修改，建立修改記錄、產(chǎn)生新的文件以取代原有文檔，最后把文檔交付文檔管理員，并奮發(fā)給有關(guān)的持有者4.7文檔的借閱和制管理制度技術(shù)文檔的借閱包括3種情況。一種是在軟件開(kāi)發(fā)部門(mén)內(nèi)部的技術(shù)文檔借閱一種是項(xiàng)目組內(nèi)部的文檔借閱一種是已經(jīng)配置管理于配置測(cè)試中心的技術(shù)文檔的借閱。對(duì)于部門(mén)內(nèi)部的技術(shù)文檔借閱，申請(qǐng)人必須擁有部門(mén)經(jīng)理的簽名許可。對(duì)于項(xiàng)目組內(nèi)部的技術(shù)文檔借閱