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

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

稱：號：制：核：準：

軟件開發(fā)技文檔管理規(guī)版號日日日生日：受狀：會簽部門

會簽人/日期

發(fā)號：會簽部門

會簽人/日期腳容

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

前

目的1術語1參考文獻1版本說明和改歷史12.

軟文

文檔的定義作用1軟件文檔的類軟件文檔的作與軟件存周期之的關系文檔的使用33.

文編格規(guī)

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

文管規(guī)

文檔管理崗職責7文檔的制作7文檔的分類、編碼與標文檔的作者、修改者和打字文檔的收集8文檔的配置8文檔的控制8文檔的修改理文檔的借閱復制管理度9文檔的保密95.

技文的量價1腳容

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

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

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

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

階段析階段階段階段階段護階段對于軟件文檔的使用人員而言與其所承擔的工作有關具體情況如下所示。管理人員：可行性研究報告。項目開發(fā)計劃書。模塊開發(fā)卷宗。開發(fā)進度月報。項目開發(fā)總結報告。開發(fā)人員：可行性研究報告。項目開發(fā)計劃書。需求分析說明書。概要設計說明書腳容

維護人員：最終用戶：

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

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

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

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

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

編寫階段總結報告，進入配置管理。4.2文檔的制作任何軟件開發(fā)技術文檔的作者必須嚴格按《軟件開發(fā)技術文檔管理規(guī)范》來制作。技術文檔的制作可以由作者本人完成，這就要求各開發(fā)人員學習文檔的制作規(guī)范，按規(guī)范進行文檔編寫。技術文檔也可以由作者本人手工書寫，交秘書來打字完成，但技術文檔的作者必須進行校對工作。腳容

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

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