1、第3章軟件文檔國家標準、3.1電腦軟件產(chǎn)品開發(fā)文檔編寫指南3.2電腦軟件需求說明編制指南3.3電腦軟件測試文檔編寫規(guī)范3.4軟件文檔管理指南， 3.0軟件工程標準我國已頒布的文件標準：計算機軟件文檔編寫規(guī)范(GB/T 8567-2006 )計算機軟件要求規(guī)范(GB/T 9385-2008 )計算機軟件測試文檔編寫規(guī)范(GB/T 9386-2008 ) 軟件文檔管理指南本標準是GB/T85671988計算機軟件產(chǎn)品開發(fā)文件創(chuàng)建指南的修訂版，更名為計算機軟件文檔創(chuàng)建規(guī)范。 實施日期起取代GB/T85671988。 GB/T 8567-1988由原電子工業(yè)部提交，中國軟件技術(shù)公司負責(zé)起草，國家標準局

2、于1988年1月7日批準，1988年7月1日實施。 在新標準實施之日廢除。 3.1.1軟件文檔的構(gòu)成根據(jù)該指南，在一個修正機軟件的開發(fā)過程中，一般需要生成14種文檔。 手冊不僅是14種文檔的制作指導(dǎo)，也是這些個14種文檔制作質(zhì)量的檢驗標準。 3.1.2各種文檔的內(nèi)容要求14種文檔的內(nèi)容和要求：詳細說明文檔、3.1計算機軟件文檔制作規(guī)范、3.2計算機軟件要求規(guī)格說明規(guī)范、計算機軟件要求規(guī)格說明規(guī)范(GB/t 9385 ) 適用于制作軟件要求規(guī)格書，記述了軟件要求書所需的內(nèi)容和品質(zhì)。 本規(guī)格是GB/T9385-1988計算機軟件要求書編寫指南的第一次修訂。 GB/T9385-1988由原電子工業(yè)部

3、于1988年4月26日批準，于1988年12月1日實施。 在新標準實施之日廢除。 3.2.1軟件要求文件編制目標srssoftwarerequirmentsspecifications軟件要求說明srs對軟件客戶來說，必須盡可能正確地描述必要的產(chǎn)品。 對于供應(yīng)商來說，應(yīng)該能夠正確理解客戶需要的產(chǎn)品。 其作用可以概括為以下6個方面：3.2計算機軟件要求規(guī)格說明規(guī)范，1關(guān)于提供什么軟件產(chǎn)品，客戶和供應(yīng)商之間協(xié)議的打底子。 SRS軟件功能的完整說明將鼎力相助潛在客戶，以確定指定的軟件是否滿足需求，以及如何定義軟件以滿足該需求。 2 .通過創(chuàng)建減少開發(fā)工作的SRS文檔，客戶組織的知情人員可以在設(shè)置修訂

4、前嚴格考慮所有需求，減少今后的重新設(shè)置修訂、重新查詢密碼和重新測試。 仔細審查SRS中的各種需求，可以在開發(fā)周期的早期查明某些泄漏、誤解、不一致，此時問題更容易糾正。3.2修訂版計算機軟件需求規(guī)格說明規(guī)范、3提供成本和進度估算基礎(chǔ)的SRS中記載的開發(fā)對象產(chǎn)品的描述，是估算項目工程成本的現(xiàn)實基礎(chǔ)，可用于獲得投標批準和價格估算。 4 .提供驗證和確認基準的優(yōu)秀SRS文檔使組織能夠提供更有效的驗證和確認訂閱。 作為開發(fā)合同的一部分，SRS提供了可用于衡量一致性的基線。 3.2計算機軟件需求規(guī)格說明規(guī)范，5軟件產(chǎn)品易于轉(zhuǎn)移SRS文檔便于將軟件產(chǎn)品轉(zhuǎn)移到新用戶機器，客戶發(fā)現(xiàn)軟件產(chǎn)品易于轉(zhuǎn)移到組織其他部門

5、，供應(yīng)商將軟件產(chǎn)品轉(zhuǎn)移到新客戶6 .進一步增強的基礎(chǔ)SRS文檔討論的是產(chǎn)品，而不是開發(fā)項目工程，因此SRS是所開發(fā)產(chǎn)品下一次增強的基礎(chǔ)。 可能需要修改SRS文檔，但它為后續(xù)產(chǎn)品評估提供了基礎(chǔ)。 3.2計算機軟件要求規(guī)格說明規(guī)格，3.2.2軟件要求書的基本要求SRS是實現(xiàn)一定功能、性能的軟件產(chǎn)品、程序或一系列計程儀程序的說明。因此，SRS的描述有兩個基本要求：1.必須描述一定的功能、性能2 .必須以確定的方式描述這些個的功能。 SRS作為軟件研發(fā)規(guī)范之一，在軟件研發(fā)的每個階段中起著非常重要的作用。 但是，請注意，SRS一般不描述配置修訂、驗證或工程項目管理的細節(jié)，但SRS不應(yīng)超出其角色范圍，即S

6、RS正確定義了所有軟件的要求。 這是對SRS的另外兩個要求。 3.2計算機軟件要求規(guī)格說明規(guī)格，3.2.3軟件要求標準適用范圍1 .適用對象： (1)正確說明軟件客戶想要獲得什么樣的產(chǎn)品(2)正確理解客戶需要什么樣的產(chǎn)品，軟件供應(yīng)商。 2 .目的： (1)提出標準化SRS提綱的開發(fā)；(2)定義自己所需的具體格式和內(nèi)容；(3)生成附加的本地條款。 3.2計算機軟件要求規(guī)范說明規(guī)范，3 .指南引用標準： (1)GB/T 8566-2007信息技術(shù)軟件生命周期過程(2)GB/T 11457-2006信息技術(shù)軟件工程師環(huán)術(shù)語。 4 .關(guān)于定義： (1)合同：是客戶和供應(yīng)商共同簽署的具有具體法律約束力的

7、文件。 其中包括產(chǎn)品的技術(shù)、組織、成本和進度修訂要求等。 3.2計算機軟件要求規(guī)格說明規(guī)范；(2)客戶：確定對產(chǎn)品支付費用、通常(但不需要)要求的個人或集團。 在某些情況下，顧客和供應(yīng)商可以是同一組織的成員。 (3)供方：為客戶開發(fā)產(chǎn)品個人或集團。 在某些情況下，客戶和供應(yīng)商可能是同一組織的成員。 (4)用戶：直接啟動系統(tǒng)產(chǎn)品或與產(chǎn)品交互的個人或集團。 用戶和客戶通常不是同一個人或組。 3.2計算機軟件要求規(guī)格說明規(guī)格3.2.4需求文件的編寫綱要綱按照數(shù)字大板塊運行模式組織的SRS具體需求數(shù)字大板塊1， 2不同用戶組織的SRS具體需求數(shù)字大板塊對象組織的SRS具體需求數(shù)字大板塊系統(tǒng)特征組織的S

8、RS具體需求數(shù)字大板塊激勵組織的SRS具體需求數(shù)字大板塊功能根據(jù)層次組織的SRS具體需求數(shù)字大板塊創(chuàng)建多種組織形式的SRS具體需求數(shù)字大板塊說明， 3.2修訂版計算機軟件需求規(guī)格說明規(guī)范、3.3修訂版計算機軟件測試文檔編寫規(guī)范、測試提高了軟件生命周期獨立檢驗失誤的概率，為了使測試能有計劃地、有條理地進行，必須編制測試文檔。 標準化的測試文檔就像一個通用的參考系統(tǒng)，以便于交流。 計算機軟件測試文檔創(chuàng)建規(guī)范(GB/T 9386-2008 )的目的是定義每個基本文檔的目的、格式和內(nèi)容的一系列軟件測試文檔。 測試文檔中規(guī)定的內(nèi)容可以作為測試流程的完全性的對照檢查表，這可以提高測試流程各階段的可視性，大

9、大提高測試工作的可管理性。 3.3計算機軟件測試文檔創(chuàng)建規(guī)范。 GB/T9386-1988計算機軟件測試文檔創(chuàng)建規(guī)范的替代規(guī)范。 原標準由上海計算機技術(shù)發(fā)展中心負責(zé)起草，原電子工業(yè)部于1988年4月26日批準，1988年12月1日實施，新標準實施之日廢止。 3.3.1標準的適用對象和范圍本規(guī)范是為軟件管理員、軟件研發(fā)、測試和維護人員、軟件質(zhì)量保證人員、審計人員、客戶和用戶制定的。 用于描述基本測試文檔的定徑套，這些文檔與實現(xiàn)定義每個基本文檔的目的、格式和內(nèi)容的軟件測試相關(guān)。 標準說明的文檔側(cè)重于動態(tài)測試活動，而某些文檔也適用于其他類型的測試活動(例如，測試計劃可用于設(shè)置和代碼評審)。 3.3計

10、算機軟件測試文檔編制規(guī)范，3.3.1標準的適用對象和范圍本標準適用于在數(shù)碼計算機上運行的商業(yè)軟件、科學(xué)訂正軟件或軍用軟件。應(yīng)用程序的范圍不受軟件的大小、復(fù)雜性或重要限制。 此規(guī)范既適用于最初開發(fā)的軟件測試文件創(chuàng)建，也適用于以后的軟件產(chǎn)品更新版本的測試文檔創(chuàng)建。 無需使用特定的測試方法學(xué)、技術(shù)、設(shè)備或工具。 不指定或強制執(zhí)行檔案管理、配置管理或質(zhì)量保證的任何特定方法學(xué)。 根據(jù)使用的方法學(xué)，可能需要添加其他文檔，如質(zhì)量保證計程儀計劃。 3.3計算機軟件測試文檔制作規(guī)范，3.3.2測試文檔的內(nèi)容本規(guī)范主要定義了三種軟件測試文檔：測試修訂版，測試說明和測試報告。 1 .測試修訂版測試修訂版描述測試活動

11、的范圍、方法、資源和進展情況。 規(guī)定測試項目、測試特性、應(yīng)完成的測試塔斯克、負責(zé)各項工作的人員以及與本計劃計程儀相關(guān)的風(fēng)險等。 3.3計算機軟件測試文檔編寫規(guī)范，2 .測試說明包括三個文檔： (1)測試設(shè)置修訂說明詳細描述測試方法，規(guī)定該設(shè)置修訂及相關(guān)測試所包含的特性，規(guī)定完成測試所需的測試用例和測試規(guī)程，規(guī)定特性合格標準。 (2)列舉用于測試用例說明輸入的具體值和預(yù)想的輸出結(jié)果，規(guī)定在使用具體的測試用例時對測試步驟的各種限制。 通過將測試用的例子和測試設(shè)計分開，可以在多個設(shè)計中使用，在其他情況下也可以重復(fù)使用。 3.3計算機軟件測試文檔編寫規(guī)范，2 .測試說明(3)測試規(guī)程說明詳細說明執(zhí)行一

12、系列測試用例的各個步驟，或者分析軟件項目以做評估一系列特征的各個步驟。 測試規(guī)程除了設(shè)定修訂以外，明確應(yīng)該遵循的步驟，不應(yīng)該包含沒有關(guān)系的詳細內(nèi)容。 3.3計算機軟件測試文檔編寫規(guī)范，3 .測試報告測試報告包括4個文檔： (1)測試項目傳遞通訊端口表示發(fā)展組和測試組獨立運行或希望正式開始測試時傳遞的測試項目。 (2)測試計程儀測試組用于記錄測試執(zhí)行中發(fā)生的情況。 3.3計算機軟件測試文檔創(chuàng)建規(guī)范；(3)測試上通告記錄通訊端口描述在測試執(zhí)行過程中出現(xiàn)并需要進一步調(diào)查的所有上通告。 (4)總結(jié)關(guān)于測試摘要記錄通訊端口測試設(shè)定修訂說明的測試活動。 3.3電腦軟件測試文檔創(chuàng)建規(guī)范，3.3.3測試文檔和

13、測試過程描述了測試文檔和其他文檔創(chuàng)建方面的關(guān)系以及測試過程之間的對應(yīng)關(guān)系。 測試文件與測試過程的關(guān)系如下圖所示。 3.3修訂版計算機軟件測試文檔編寫規(guī)范，測試文檔與測試過程的關(guān)系，3.3.4測試文檔的結(jié)構(gòu)共有8個文檔：測試修訂版測試設(shè)定修訂說明測試案例說明測試項目傳達報告測試計程儀測試上通告報告測試總結(jié)報告， 3.3修訂版計算機軟件測試文檔編寫規(guī)范3.3.5測試文檔創(chuàng)建軟件測試文檔的內(nèi)容主要包括：測試修訂版、測試設(shè)置修訂版、測試用例描述、測試規(guī)程描述、測試項目傳遞報告、測試計程儀、測試上通告報告及測試總結(jié)報告8項。 必須強調(diào)軟件測試包括需求說明書的測試。 因此，在軟件需求分析階段開始制作測試文

14、檔，各種測試文檔的制作必須以一定的形式進行。 3.3計算機軟件測試文檔創(chuàng)建規(guī)范，3.3.5測試文檔創(chuàng)建1 .測試用例(test case )對特定軟件產(chǎn)品進行測試塔斯克描述，體現(xiàn)測試方案、方法、技術(shù)和策略。 內(nèi)容包括并記錄測試目標、測試環(huán)境、輸入數(shù)據(jù)、測試過程、預(yù)期結(jié)果、測試腳本等。 測試用例因軟件的種類而異。 對于軟件產(chǎn)品的功能、業(yè)務(wù)規(guī)則、業(yè)務(wù)流程，必須針對各個開發(fā)階段的軟件產(chǎn)品設(shè)定測試用例。 可以減少人為的影響。3.3修訂版計算機軟件測試文檔編寫規(guī)范，3.3.5測試文檔的編制2 .測試文檔的編制測試文檔主要由幾個測試用例組成。 各種測試文檔的編制應(yīng)當按照文檔數(shù)字大板塊以一定的形式進行，編制

15、時可以參考修訂機軟件文檔編寫規(guī)范。 測試文檔由概要和測試用例兩部分組成。 3.3電腦軟件測試文檔的制作規(guī)范、3.3.6測試文檔的制作實例是實施測試文件的制作的初期階段，首先可以制作測試修訂畫和測試報告文件。 測試修訂計劃為整個測試過程提供了基礎(chǔ)。 測試報告建議測試單位正確記錄整個測試過程的情況。 經(jīng)過有會兒實踐，積累了一定經(jīng)驗后，逐步導(dǎo)入其他文件。 測試文件的創(chuàng)建最終形成了與設(shè)置修訂層相對應(yīng)的文件層次結(jié)構(gòu)，如系統(tǒng)測試文件、子系統(tǒng)測試文件、模塊測試文件等。 本公司使用的特定測試技術(shù)的文檔編寫是本文所述的基本文件定徑套的補充。3.3電腦軟件測試文檔的編制規(guī)范、3.3.6測試文檔的編制實例項目工程修

16、訂版和單位標準，應(yīng)該指定哪些測試報告需要哪些測試文件，在文件中添加一些內(nèi)容，使各文件適合特定的測試項目和特定的測試環(huán)境。 一個測試文件創(chuàng)建示例、3.3計算機軟件測試文檔創(chuàng)建規(guī)范、軟件文檔管理指南(GB/T 16680-1996 )是用于為負責(zé)開發(fā)軟件或基于軟件的產(chǎn)品的管理員提供軟件文檔的管理指南其目的是鼎力相助管理員在組織中生成有效文檔。 3.4軟件文檔管理指南、3.4.1軟件文檔管理概述軟件文檔管理包括策略、標準、規(guī)章、資源和修訂版，管理者必須著眼于這些個的內(nèi)容，有效地管理軟件文檔。 軟件文檔管理應(yīng)適用于各種類型的軟件，簡單復(fù)雜，復(fù)蓋各種類型的軟件文檔，軟件文檔管理指南，無論應(yīng)用于軟件生存期的各個階段的項目工程大小如何軟件文檔管理是為了文檔制作管理而提出的，與軟件文檔的內(nèi)容和組織無關(guān)。3.4軟件文檔管理指南、3.4.2軟件文檔和文檔管理員嚴格要求軟件研發(fā)人員和編制小組編制文檔，在戰(zhàn)略、標準、規(guī)章、資源分配和編制修訂方面給予支持通訊端口。 主要作用包括三個方面：1.管理者對文件工作的責(zé)任管理者應(yīng)認識到正式或非官方文件的重要性，文件工作應(yīng)包括文件的修訂、制作、修改、形成、分發(fā)和維護等各個方面。 2 .管理員通訊端口文檔工作的管理員必須為文檔作者提供指導(dǎo)和實際鼓勵，并有效地使用各種資源進行文檔開發(fā)。3.4軟件文檔管理指南、3.4.2軟件文檔和文檔管理員3 .管理員的主要角色(1)