【正文】 細(xì)設(shè)計(jì)說明書。 ? 數(shù)據(jù)庫 設(shè)計(jì)說明書。 ? 用戶手冊。 ? 操作手冊。 ? 模塊開發(fā)卷宗。 ? 測試計(jì)劃。 ? 測試分析報(bào)告。 ? 開發(fā)進(jìn)度月報(bào)。 ? 項(xiàng)目開發(fā)總結(jié)報(bào)告。 軟件開發(fā)技術(shù)文檔管理規(guī)范 第 3頁 共 59頁 軟件文檔的制作與軟件生存周期之間的關(guān)系 一般而言，計(jì)算機(jī)軟件生存周期可以分為六個(gè)階段： ? 可行性與計(jì)劃研究階段。 ? 需求分析階段。 ? 設(shè)計(jì)階段。 ? 實(shí)現(xiàn)階段。 ? 測試階段。 ? 運(yùn)行與維護(hù)階段。 在軟件開發(fā)的不同階段，產(chǎn)生的軟件文檔不同，具體對應(yīng)關(guān)系如下表所示。 階段 文檔 可行性研究與計(jì)劃階段 需求分析階段 設(shè)計(jì)階段 實(shí)現(xiàn)階段 測試階段 運(yùn)行與維護(hù)階段 可行性研究報(bào) 告 項(xiàng)目開發(fā)計(jì)劃 軟件需求說明書 數(shù)據(jù)要求說明書 測試計(jì)劃 概要設(shè)計(jì)說明書 詳細(xì)設(shè)計(jì)說明書 數(shù)據(jù)庫設(shè)計(jì)說明書 模塊開發(fā)卷宗 用戶手冊 操作手冊 測試分析報(bào)告 開發(fā)進(jìn)度月報(bào) 項(xiàng)目開發(fā)總結(jié) 文檔的使用者 對于軟件文檔的使用人員而言，與其所承擔(dān)的工作有關(guān)，具體情況如下所示。 管理人員： ? 可行性研究報(bào)告。 ? 項(xiàng)目開發(fā)計(jì)劃書。 ? 模塊開發(fā)卷宗。 ? 開發(fā)進(jìn)度月報(bào)。 ? 項(xiàng)目開發(fā)總結(jié)報(bào)告。 開發(fā)人員： ? 可行性研究報(bào)告。 ? 項(xiàng)目開發(fā)計(jì)劃書。 ? 需求分析說明書。 ? 概要設(shè)計(jì)說明書 軟件開發(fā)技術(shù)文檔管理規(guī)范 第 4頁 共 59頁 ? 詳細(xì)設(shè)計(jì)說明書 ? 數(shù)據(jù)庫設(shè)計(jì)說明書。 ? 測試計(jì)劃。 ? 測試分析報(bào)告。 維護(hù)人員： ? 設(shè)計(jì)說明書。 ? 測試分析報(bào)告。 ? 模塊開發(fā)卷宗。 ? 最終用戶： ? 系統(tǒng)安裝手冊。 ? 用戶手冊。 ? 系統(tǒng)維護(hù)手冊。 ? 系統(tǒng)功能說明書 3. 文檔編制格式規(guī)范 文檔編碼規(guī)則 公司所有的技術(shù)文檔，都必須具有一個(gè)唯一的系列號，格式為： PRSPIDXX： 1) “ PRS”：創(chuàng)智 標(biāo)識符（ Company Flag)。 2) “ PID”：項(xiàng)目代號。 3) “ XX”：文檔標(biāo)識號，參見《軟件開發(fā)配置管理規(guī)程》。 例如，文件號： 表示：該文件由本公司產(chǎn)品 PowerOffice， MD表示是管理文檔， 001表示是項(xiàng)目開發(fā)計(jì)劃書，版本號 PowerOffice產(chǎn)品 。 文檔組成格式 公司所有文檔（僅一頁的文件可按單頁文檔格式組織）由封面、目錄（ Content Table)、版本更新說明書（ Rivision)、文 件內(nèi)容等組成，如圖所示 封面版本說明文件內(nèi)容參考文獻(xiàn)附錄名詞索引目錄 軟件開發(fā)技術(shù)文檔管理規(guī)范 第 5頁 共 59頁 圖 1文檔組成檔式 封面 封面組成可劃分為： 1. 文檔號 ： . 文檔系列號 (文檔文件名 ) 字體 : Arial , 小四 , 加粗 例： . PRSPIDXX () 2. 項(xiàng)目名稱 : 中文字體 : 黑體 , 三號字體 , 加粗 英文字體 : Arial , 三號字體 , 加粗 例： 創(chuàng)智文檔規(guī)范 3. 文檔名稱 : 中文字體：黑體 , 一號字體 , 加粗 英文字體： Arial, 一號字體 , 加粗 例： 工程技術(shù)項(xiàng)目文檔規(guī)范 4. 密級 ：英文字體 : Arial, 小四字體 , 加粗 劃分為五類，采用下列關(guān)鍵詞 Top Confidential High Confidential Confidential Normal General ? Top Confidential：絕密 產(chǎn)品文檔 ? High Confidential：機(jī)密 規(guī)范、指南 ? Confidential：秘密 計(jì)劃、管理 ? Normal：普通 工作崗位有關(guān) ? General：明文 可以在社會(huì)上廣為流傳 例 : Normal 5. 版本號 ：關(guān) 鍵詞為 Version 用 Arial 字體 , 大小為小四號 例 : Version 6. 完成日期 ：用 Arial 字體 , 大小為小四號 例 : . 7. 作者 ： Written By??用 Arial 字體 ,大小為小四號 , 加粗 例 : Written By POWERISE 8. 公司 LOGO: 用 USABLack 字體 ,大小為四號 , 加粗。 例 : POWERISE : 軟件開發(fā)技術(shù)文檔管理規(guī)范 第 6頁 共 59頁 關(guān)鍵詞為：創(chuàng)智軟件園有限公司 Powerise Software. Inc. 版權(quán)生效年限：關(guān)鍵詞為（ C）公歷年號 中文字體 : 黑體 , 四號 , 加粗 例 : 創(chuàng)智軟件園有限公司 (C)1994,1999 注：此處填寫產(chǎn)品已經(jīng)經(jīng)過的年份，如 PowerLCMS,copyrights(C)1996,1998. 英文字體 : Arial , 四號 , 加粗 例 : Powerise .(C)1994,1995 10. 版權(quán)申明 ：字體為 : Arial , 小四 , 加粗 例 : All Right Reserved 各項(xiàng)安排如下圖 ,樣板范 例可參見本文檔的封面： ???????????????? ? ?12435678910? 目錄 可采用手工編制或使用文檔編制 Microsoft Word 的自動(dòng)生成目錄的功能產(chǎn)生文檔目錄。 版本更新說明 關(guān)鍵詞為： Revision 內(nèi)容劃分為：日期 (Date)、理由 (Reason)、更新者(Revisor)。 (首版可省略該節(jié) ) 文件內(nèi)容 文件內(nèi)容每一頁必須包含下列三項(xiàng)，缺一不可： ? 頁首，在頁首中部自動(dòng)填入‘標(biāo)題 1’的名稱。 ? 頁腳，在頁腳左部填入創(chuàng)智標(biāo)徽 POWERISE，右部填入頁號。 ? 正文。 軟件開發(fā)技術(shù)文檔管理規(guī)范 第 7頁 共 59頁 如下圖所示，具體設(shè)置可復(fù)制本文作模塊。 標(biāo)題 PoweriseΘ 創(chuàng)智（創(chuàng)智標(biāo)徽 image） 第 X頁 正文格式 標(biāo)題一：宋體、小三、粗體，左對齊； 標(biāo)題二：黑體、四號、粗體，左對齊； 標(biāo)題三：宋體、小四號、粗體，左對齊； 標(biāo)題四：黑體、小四號、正常體，左對齊； 標(biāo)題五：黑體、五號、粗體，左對齊； 正文：宋體、小四號、正常體，左對齊。 以上行距為單倍行距。 文檔制作工具 使用何種文檔制作工具，原則上沒有限制，但必需考慮到文檔交流的方便 性問題。因此，如果在文檔的交流方面，因?yàn)槲臋n制作工具的使用差異造成工作上的不便，文檔制作者本人應(yīng)該設(shè)法解決。 用于交流和上交的文檔登記說明上，應(yīng)注明所使用的文檔制作工具。 4. 文檔管理規(guī)范 文檔管理崗位職責(zé) 產(chǎn)生文檔的單位包括：開發(fā)部的項(xiàng)目組和配置測試中心的配置測試組。 項(xiàng)目組的職責(zé)： ? 編寫開發(fā)計(jì)劃書，評審 /審查通過后，向配置測試組提交，進(jìn)入配置管理。 ? 編寫階段開發(fā)計(jì)劃書、技術(shù)文檔，經(jīng)過評審 /審查后，向配置測試組軟件開發(fā)技術(shù)文檔管理規(guī)范 第 8頁 共 59頁 提交，進(jìn)入配置管理。 ? 編寫階段總結(jié)報(bào)告，向配置測試組提交，進(jìn)入配置管理。 配置測試組的職 責(zé)： ? 編寫配置測試評審計(jì)劃書，評審 /審查通過后，進(jìn)入配置管理。 ? 編寫階段計(jì)劃書、配置、測試和評審文檔，經(jīng)過評審 /審查后，進(jìn)入配置管理。 ? 收集項(xiàng)目組的管理文檔和技術(shù)文檔 ? 執(zhí)行階段計(jì)劃書、配置、測試和評審，經(jīng)過評審 /審查后，進(jìn)入配置管理。 ? 編寫階段總結(jié)報(bào)告，進(jìn)入配置管理。 文檔的制作 任何軟件開發(fā)技術(shù)文檔的作者必須嚴(yán)格按照《軟件開發(fā)技術(shù)文檔管理規(guī)范》來制作。 技術(shù)文檔的制作可以由作者本人完成，這就要求各開發(fā)人員學(xué)習(xí)文檔的制作規(guī)范，按規(guī)范進(jìn)行文檔編寫。 技術(shù)文檔也可以由作者本人手工書寫，交秘書來打字完成，但技術(shù)文 檔的作者必須進(jìn)行校對工作。 文檔的分類、編碼與標(biāo)識 參見《軟件開發(fā)配置管理規(guī)程》 文檔的作者、修改者和打字者 對此管理的目的是明確文檔的來源，使整個(gè)開發(fā)的流程清晰可查。以便今后可就某個(gè)技術(shù)細(xì)節(jié)找到相應(yīng)的人（作者）進(jìn)行更進(jìn)一步的探討和學(xué)習(xí)。也便于對某個(gè)項(xiàng)目的工作任務(wù)作出合理的安排。 每本文檔在形成時(shí)，在封面就須寫清楚文檔的第一作者及其合作者。如果文檔進(jìn)行了修改、改版，在版本更新說明中，還必須寫清修改人。 在對文檔進(jìn)行登記歸檔時(shí)也必須如實(shí)記錄作者。其中有第一作者，修改者。同時(shí)記錄打印人和定稿打印的日期。 文檔的收集 技術(shù)文檔的收集包括 2 種方式。一種是作者將完成的合乎規(guī)范的技術(shù)文檔主動(dòng)交配置測試中心關(guān)于本項(xiàng)目指定的配置測試工程師進(jìn)行配置管理。一種是配置測試中心關(guān)于本項(xiàng)目的配置測試工程師，根據(jù)項(xiàng)目階段任務(wù)和階段成果的安排，在適當(dāng)?shù)臅r(shí)候向相關(guān)的文檔制作者收集技術(shù)文檔，進(jìn)行配置管理和版本控制。 軟件開發(fā)技術(shù)文檔管理規(guī)范 第 9頁 共 59頁 文檔的配置 與項(xiàng)目有關(guān)的管理文檔和技術(shù)文檔的管理最終統(tǒng)一歸口于軟件配置測試中心的配置管理組。技術(shù)文檔的管理方式是按部門、部門下面的項(xiàng)目組、項(xiàng)目組的不同階段加以配置管理和版本控制例如： 開發(fā)一部開發(fā)二部開發(fā)三部 P T MI S湖南人行公安、消防設(shè)計(jì)書類操作手冊維護(hù)手冊方案類測試類開發(fā)卷宗 以上只是管理的一種形式，它是根據(jù)部門來分類。另外還可以根據(jù)其它特征來分類。這些特征有時(shí)間、作者、部門、項(xiàng)目、文檔類別等。具體采用什么樣的特征可根據(jù)具體情況進(jìn)行適當(dāng)?shù)姆诸悺? 在對文檔進(jìn)行管理時(shí)，必須對每一份正式的文檔進(jìn)行詳細(xì)的登記。登記時(shí)的原則是：手續(xù)嚴(yán)密、格式清晰醒目、簡化適用、登記項(xiàng)目完整詳盡。這樣在對文檔進(jìn)行管理時(shí)便于查找文檔和檢查文檔的運(yùn)轉(zhuǎn)情況。一般采用簿式登記，以便清晰可查。 文檔的控制 為保持文檔和程序產(chǎn)品的一致性，保持各種文件之間的一致性和文件的安全性，需要對文檔進(jìn) 行控制，具體表現(xiàn)在： ? 應(yīng)該有文檔管理員集中保管本項(xiàng)目現(xiàn)有全部文檔的主文本兩套，由其負(fù)責(zé)保管 ? 每一份提交給文檔管理人員的文檔必需具有編寫人、審核人和批準(zhǔn)人的簽字 ? 兩套文本的內(nèi)容一致，其中一套可以出借，另一套絕對不可以出借 ? 文檔的借閱和歸還必需有出借和注銷的手續(xù) ? 項(xiàng)目組種的個(gè)人文檔必需和整個(gè)項(xiàng)目的主文檔的內(nèi)容和版本一致 ? 一份文檔如果被新文檔更新，原文件必需注銷 文檔的修改管理 在項(xiàng)目開發(fā)過程中，項(xiàng)目組內(nèi)部的任何人都可以提議對開發(fā)工作的文件成軟件開發(fā)技術(shù)文檔管理規(guī)范 第 10頁 共 59頁 果進(jìn)行修改，但必需遵循如下的步驟： ? 提議：項(xiàng)目組內(nèi)部任何一個(gè)人 都可以填寫修改建議表，提出對文檔的修改建議 ? 評議：由項(xiàng)目負(fù)責(zé)人或項(xiàng)目負(fù)責(zé)人制定指定的人員對文檔修改提議進(jìn)行評議，包括審查該項(xiàng)修改的必要性、影響范圍、研究進(jìn)行修改的方法、步驟和實(shí)施計(jì)劃 ? 審核：由項(xiàng)目負(fù)責(zé)人進(jìn)行審核，包括合適修改的目的和要求、核實(shí)修改活動(dòng)將帶來的影響、審核修改活動(dòng)計(jì)劃是否可行 ? 批準(zhǔn)：由開發(fā)單位的部門負(fù)責(zé)人進(jìn)行批準(zhǔn)，主要是決斷修改工作中各項(xiàng)活動(dòng)的先后順序及各自完成日期，以保證整個(gè)開發(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)的持有者 文檔的借閱和復(fù)制管理制度 技術(shù)文檔的借閱包括 3 種情況。一種是在軟件開發(fā)部門內(nèi)部的技術(shù)文檔借閱。一種是項(xiàng)目組內(nèi)部的文檔借閱，一種是已經(jīng)配置管理于配置測試中心的技術(shù)文檔的借閱。 對于部門內(nèi)部的技術(shù)文檔借閱，申請人必須擁有部門經(jīng)理的簽名許可。 對于項(xiàng)目組內(nèi)部的技術(shù)文檔借閱，申請人必須擁有項(xiàng)目經(jīng)理或總設(shè)計(jì)師的簽名許可。 對于配置測試中心特定技術(shù)文檔的借閱，必須擁有主管技術(shù)副總裁或技術(shù)總監(jiān)的簽名許可。 文檔的保密性 對于任何一種技術(shù)文檔，必須按 密級進(jìn)行管理，技術(shù)文檔的密級在制作規(guī)范中已經(jīng)說明。借閱制度如下： ? 明文（ General）：可以自由借閱，只要辦理一下借閱手續(xù)即可。出借的文檔要登記文檔份數(shù)，文件名，借閱人，預(yù)期歸還時(shí)間。如須長期使用，要保留復(fù)印件； ? 普通（ Normal）：只有本公司特定崗位的技術(shù)人員才可以使用的文