計(jì)算機(jī)軟件文檔編制規(guī)范.ppt

馮惠,GB/T 8567-2006 計(jì)算機(jī)軟件文檔編制規(guī)范,目次,1 修訂背景 修訂依據(jù) 新老版本的差異 新版標(biāo)準(zhǔn)結(jié)構(gòu) 文檔編制過程 文檔編制要求 文檔編制格式 小結(jié),一、本標(biāo)準(zhǔn)修訂的背景,版是參考英國某公司的文檔標(biāo)準(zhǔn)，結(jié)合當(dāng)時(shí)國內(nèi)軟件開發(fā)的經(jīng)驗(yàn)，而且主要是針對(duì)瀑布模型的開發(fā)方法而制定的。該標(biāo)準(zhǔn)的發(fā)布與實(shí)施對(duì)我國上世紀(jì)八十年代、九十年代的軟件開發(fā)發(fā)揮了重要作用。但隨著時(shí)間的推移，軟件工程技術(shù)的發(fā)展與提高，目前來看，版已經(jīng)不適應(yīng)軟件產(chǎn)業(yè)發(fā)展的需要，因此修訂版勢在必行。,二、GB/T8567-2006制定的依據(jù),主要依據(jù)： 信息技術(shù) 軟件生存周期過程 軟件開發(fā)與文檔編制 ： 信息技術(shù) 軟件用戶文檔過程,三、新老版本的主要差異,主要適用于瀑布模型開發(fā)方法 給出了種文檔的編制格式要求： ）可行性研究報(bào)告 ）項(xiàng)目開發(fā)計(jì)劃 ）軟件需求說明書,新老版本的主要差異,）數(shù)據(jù)要求說明書 ）概要設(shè)計(jì)說明書 ）詳細(xì)設(shè)計(jì)說明書 ）數(shù)據(jù)庫設(shè)計(jì)說明書 ）用戶手冊(cè) ）操作手冊(cè) ）模塊開發(fā)卷宗 ）測試計(jì)劃 ）測試分析報(bào)告 ）開發(fā)進(jìn)度月報(bào) ）項(xiàng)目開發(fā)總結(jié)報(bào)告,新老版本的主要差異,6原則上適用于各種類型的開發(fā)方法 6描述了文檔編制過程 6給出種文檔的編制格式要求 ）可行性分析（研究）報(bào)告 ）軟件開發(fā)計(jì)劃 ）軟件測試計(jì)劃 ）軟件安裝計(jì)劃,新老版本的主要差異,）軟件移交計(jì)劃 ）運(yùn)行概念說明 ）系統(tǒng)子系統(tǒng)需求規(guī)格說明 ）接口需求規(guī)格說明 ）系統(tǒng)子系統(tǒng)設(shè)計(jì)（結(jié)構(gòu)設(shè)計(jì)）說明 ）接口設(shè)計(jì)說明 ）軟件需求規(guī)格說明 ）數(shù)據(jù)需求說明 ）軟件（結(jié)構(gòu)）設(shè)計(jì)說明,新老版本的主要差異,）數(shù)據(jù)庫（頂層）設(shè)計(jì)說明 ）軟件測試說明 ）軟件測試報(bào)告 ）軟件配置管理計(jì)劃 ）軟件質(zhì)量保證計(jì)劃 ）開發(fā)進(jìn)度月報(bào) ）項(xiàng)目開發(fā)總結(jié)報(bào)告,新老版本的主要差異,）軟件產(chǎn)品規(guī)格說明 ）軟件版本說明 ）軟件用戶手冊(cè) ）計(jì)算機(jī)操作手冊(cè) ）計(jì)算機(jī)編程手冊(cè) 另外給出了面向?qū)ο蟮姆N文檔的編制格式要求,四、6標(biāo)準(zhǔn)結(jié)構(gòu),、范圍 、規(guī)范性引用文件 、術(shù)語和定義 、縮略語 、文檔（編制）過程 、文檔編制要求 、文檔編制格式 附錄 面向?qū)ο筌浖奈臋n編制,五、文檔（編制）過程 5.1 概述,有兩種主要類型的標(biāo)準(zhǔn)： a. 產(chǎn)品標(biāo)準(zhǔn)，它規(guī)定產(chǎn)品的特征和功能需求； b. 過程標(biāo)準(zhǔn)，它規(guī)定開發(fā)產(chǎn)品的過程。 應(yīng)用程序和計(jì)算機(jī)軟件的復(fù)雜性日益增加，使得給使用計(jì)算機(jī)的用戶提供完整的、正確的和易懂的文檔的需要更加迫切。本標(biāo)準(zhǔn)通過規(guī)定影響軟件文檔的質(zhì)量的活動(dòng)（做什么和由誰做），提供達(dá)到這些目的的工具。,文檔常常是關(guān)心在軟件已經(jīng)實(shí)現(xiàn)后做些什么。然而，為了質(zhì)量，軟件文檔編制應(yīng)作為整個(gè)軟件生產(chǎn)過程的一部分。過程計(jì)劃應(yīng)把文檔計(jì)劃包括在內(nèi)。本標(biāo)準(zhǔn)也給用戶和客戶提供工具以保證文檔過程實(shí)施。 本標(biāo)準(zhǔn)的主要活動(dòng)之一是建立開發(fā)文檔的廣泛計(jì)劃。這是必須的，因?yàn)橛杏?jì)劃，文檔編制的質(zhì)量會(huì)更好，過程的效率會(huì)更高。為遵循本標(biāo)準(zhǔn)，計(jì)劃必須包括風(fēng)格規(guī)格說明。本標(biāo)準(zhǔn)不規(guī)定風(fēng)格規(guī)格說明的內(nèi)容（即不規(guī)定具體的布局和字體），但它規(guī)定風(fēng)格規(guī)格說明必須覆蓋什么。本標(biāo)準(zhǔn)也規(guī)定何種信息對(duì)于文檔管理者是可用的和誰做評(píng)審和再生產(chǎn)文檔。,5.2 文檔（編制）過程的關(guān)注點(diǎn),文檔編制計(jì)劃 文檔開發(fā)（編制） 文檔評(píng)審,5.3 文檔計(jì)劃,5.3.1 概要 文檔管理者應(yīng)準(zhǔn)備一文檔計(jì)劃，此計(jì)劃規(guī)定在文檔創(chuàng)建中要執(zhí)行的工作。此文檔計(jì)劃應(yīng)經(jīng)需方正式同意，以預(yù)示它完全覆蓋了需方的要求。 l 文檔計(jì)劃通常將覆蓋整個(gè)文檔系列。 文檔計(jì)劃應(yīng)正式地描述計(jì)劃的文檔的范圍和限制，以及重要的文檔分析和設(shè)計(jì)決定。也應(yīng)規(guī)定在文檔開發(fā)期間實(shí)現(xiàn)的過程和控制。,文檔計(jì)劃應(yīng)包括（但不限于）以下內(nèi)容： a）計(jì)劃的文檔的工作名稱、目的、范圍和限制。 b）文檔的預(yù)定的讀者，和使用的目的。 c）文檔內(nèi)容的草案表，帶有估計(jì)的頁數(shù)和其他媒體的等效細(xì)節(jié)。 d）交付：打印副本數(shù)，是否提供電子副本，磁盤和文件格式（包括軟件版本）和在何處交付。 e）版權(quán)的擁有者和任何其他所有權(quán)。 l 這是復(fù)雜的問題，應(yīng)在合同中規(guī)定。,f）適當(dāng)處，包括每個(gè)文檔的安全或機(jī)密級(jí)。 g）管理文檔開發(fā)過程的步驟和控制，包括存儲(chǔ)、檢索、后備、處理和質(zhì)量保證（若要求）。 h）所用的生產(chǎn)方法、工具和工具版本。 i）文檔開發(fā)人員所在的隊(duì)伍的結(jié)構(gòu)，任選地，包括隊(duì)伍選擇計(jì)劃。 l 在文檔編寫和生產(chǎn)的不同階段中的工作人員，需要不同的技巧。編寫人員可能要求對(duì)正在編寫的系統(tǒng)有好的知識(shí)加上寫文檔的經(jīng)驗(yàn)；編輯人員可能要求有編輯經(jīng)驗(yàn)而對(duì)系統(tǒng)知識(shí)無要求；版面藝術(shù)家可能對(duì)所用的版面工具外，無任何知識(shí)要求。,j）項(xiàng)目依賴。 k）所要求的人時(shí)和成本。 l）項(xiàng)目資源需求，包括需方提供的信息和其他資源。 m）在軟件開發(fā)期間，軟件變更傳送信息給文檔管理者的方法。 n）文檔的變更控制和維護(hù)的計(jì)劃（任選）。 o）實(shí)現(xiàn)后評(píng)審的計(jì)劃（任選）。,p）顯示適當(dāng)?shù)睦锍瘫臅r(shí)間表，包括： 1）文檔計(jì)劃批準(zhǔn)； 對(duì)于文檔的每一項(xiàng)應(yīng)重復(fù)。 l 文檔計(jì)劃宜2）每個(gè)草案的準(zhǔn)備、評(píng)審和改正； 3）可用性測試； 4）打印、裝訂和發(fā)布。 若適當(dāng)，這些活動(dòng)的每一個(gè)在文檔的開發(fā)開始以前準(zhǔn)備與批準(zhǔn)，以保證所有部門同意目標(biāo)和所用的方法。批準(zhǔn)后，計(jì)劃宜盡可能廣泛地分發(fā)；分發(fā)宜包括所有文檔開發(fā)人員和可能包括需方人員及子合同方。,5.3.2 文檔計(jì)劃控制 在正式同意后，文檔管理者應(yīng)控制文檔計(jì)劃和它的發(fā)布。文檔管理者應(yīng)保持一份文檔計(jì)劃副本的分發(fā)的清單。若以后文檔計(jì)劃變更了（得到文檔管理者和需方的同意），文檔管理者應(yīng)保證所有得到文檔計(jì)劃副本的人員，應(yīng)得到變更通知。 l 因?yàn)?，?jì)劃的過時(shí)的副本可能引起問題，文檔管理者宜禁止計(jì)劃的未控制的副本并制訂計(jì)劃的所有副本已經(jīng)更新的審核過程。,5.4 文檔開發(fā),按文檔計(jì)劃規(guī)定進(jìn)行文檔開發(fā)。通常，在進(jìn)行文檔開發(fā)前，要規(guī)定文檔的格式（風(fēng)格）。在軟件的開發(fā)和管理過程中需要那些文檔，每種文檔的規(guī)范在下面說明。,5.5 評(píng)審,5.5.1 概述 本節(jié)規(guī)定文檔評(píng)審的要求和相關(guān)活動(dòng)。本節(jié)主要以用戶文檔的評(píng)審為例說明。對(duì)于開發(fā)文檔的評(píng)審，由供方組織和實(shí)施。而批準(zhǔn)由開發(fā)組織的上級(jí)技術(shù)機(jī)構(gòu)實(shí)施。更要著重經(jīng)常性的、非正式的注重實(shí)效的評(píng)審。不是要追求形式。,用戶文檔的評(píng)審應(yīng)由需方實(shí)現(xiàn)，包括當(dāng)需要時(shí)與文檔管理者討論。 l 評(píng)審的目的是保證提交的材料是完整的和正確的并滿足了在合同和文檔計(jì)劃中定義的需方的需要。 評(píng)審宜由合適的有資格的人員執(zhí)行，這些人員被授權(quán)請(qǐng)求變更和批準(zhǔn)文檔的內(nèi)容。 l 需方宜限止評(píng)審人員數(shù)為評(píng)審功能所必需的那些。 需方在批準(zhǔn)每個(gè)用戶文檔草案之前，應(yīng)保證文檔的安全和合法。 為評(píng)審交付的文檔應(yīng)包括從文檔管理者來的說明書，說明評(píng)審的目的和評(píng)審員的職責(zé)。,l 注1：在需方和文檔管理者之間在整個(gè)開發(fā)過程期間維持良好的通信會(huì)提高文檔的質(zhì)量并利于評(píng)審成功。這宜包括非正式的討論和盡早地提供樣板或初始材料給需方。 l 注2：在要求的變更超出了合同和文檔計(jì)劃的范圍時(shí)，需要變更合同。 l 注3：評(píng)審過程不免除文檔管理者，他們的責(zé)任是試圖盡可能保證文檔的精確和完整。 l 注4：從評(píng)審的結(jié)果而來的需方的評(píng)論結(jié)果宜用或是加上標(biāo)記的草案或用有適當(dāng)?shù)膮⒖嫉姆绞綄懺u(píng)論。需方宜保持變更的副本為了與下一草案相比較。評(píng)論應(yīng)使文檔開發(fā)人員能實(shí)現(xiàn)所要求的變更而不需要評(píng)審人員的進(jìn)一步解釋。 l 注5：對(duì)于大的、復(fù)雜的系統(tǒng)或正在寫文檔時(shí)系統(tǒng)仍在開發(fā)，可能需要多于兩次草案和一次校樣。在這樣情況下，最多的草案數(shù)宜在需方和文檔管理者之間同意并在文檔計(jì)劃中規(guī)定。,5.5.2 文檔計(jì)劃評(píng)審 此評(píng)審的目的應(yīng)保證文檔計(jì)劃定義的文檔，當(dāng)完成時(shí)，既滿足開發(fā)過程的需要也滿足需方在合同中規(guī)定的的文檔目標(biāo)。需方同意文檔計(jì)劃，是同意在計(jì)劃中定義的用戶文檔的所有可交付的特征。 l 注：需方宜放注意至在內(nèi)容的草案表中展示的文檔的結(jié)構(gòu)、完整性和可用性。只要適當(dāng)，文檔計(jì)劃宜在第一個(gè)草案開始工作之前評(píng)審和批準(zhǔn)。,5.5.3 第一個(gè)草案評(píng)審 第一個(gè)草案應(yīng)包含如在文檔計(jì)劃中描述的文檔主體，加上內(nèi)容表，附錄和詞匯。在使用自動(dòng)索引工具處，生成的索引包含位置參照。標(biāo)點(diǎn)符號(hào)、風(fēng)格和版面應(yīng)如在文檔計(jì)劃中描述的。 文檔的第一個(gè)草案的評(píng)審目的是核查文檔的技術(shù)正確性和完整性，以保證草案滿足文檔計(jì)劃的目標(biāo)。標(biāo)點(diǎn)符號(hào)、風(fēng)格和版面應(yīng)如在文檔計(jì)劃中定義的。,在批準(zhǔn)第一個(gè)草案中，除了要求的變更外，評(píng)審批準(zhǔn)技術(shù)正確性、結(jié)構(gòu)清楚性和文檔的完整性。 l 注1：第一個(gè)草案宜在交付前編輯。這有兩個(gè)理由： a）這保證評(píng)審者不分心于改正印刷的和版面的錯(cuò)誤； b）保證由編輯過程引起的任何技術(shù)錯(cuò)誤被評(píng)審者捕獲。 l 注2：草案應(yīng)針對(duì)在文檔計(jì)劃中批準(zhǔn)的目標(biāo)、讀者定義、內(nèi)容表和其他特征進(jìn)行評(píng)審。在帶有評(píng)論的第一個(gè)草案返回前，宜確認(rèn)，若草案完全改正了，將滿足文檔計(jì)劃的要求。,5.5.4 第二個(gè)草案評(píng)審 第二個(gè)草案應(yīng)包在第一個(gè)草案評(píng)審中同意的所有變更且應(yīng)以盡可能接近最后的形式包括在文檔計(jì)劃中定義的可交付的內(nèi)容。 此評(píng)審的目的是核查在第一個(gè)草案中的內(nèi)容已經(jīng)正確實(shí)現(xiàn)。 在第二個(gè)草案的批準(zhǔn)中，除了草案的物理形式外，批準(zhǔn)文檔的所有方面。草案的物理形式可能與可交付的不精確相同。 l 注：在批準(zhǔn)第二個(gè)草案前，宜確認(rèn)草案（包含評(píng)審對(duì)草案的評(píng)論）已經(jīng)準(zhǔn)備好批準(zhǔn)。,六、文檔編制要求,6.1 軟件生存周期與各種文檔的編制,在計(jì)算機(jī)軟件的生存周期中，一般地說，應(yīng)該產(chǎn)生以下一些基本文檔。 可行性分析（研究）報(bào)告； 軟件（或項(xiàng)目）開發(fā)計(jì)劃； 軟件需求規(guī)格說明； 接口需求規(guī)格說明； 系統(tǒng)子系統(tǒng)設(shè)計(jì)（結(jié)構(gòu)設(shè)計(jì)）說明； 軟件（結(jié)構(gòu)）設(shè)計(jì)說明；,接口設(shè)計(jì)說明； 數(shù)據(jù)庫（頂層）設(shè)計(jì)說明； （軟件）用戶手冊(cè)； 操作手冊(cè)； 測試計(jì)劃； 測試報(bào)告；,軟件配置管理計(jì)劃； 軟件質(zhì)量保證計(jì)劃； 開發(fā)進(jìn)度月報(bào)； 項(xiàng)目開發(fā)總結(jié)報(bào)告； 軟件產(chǎn)品規(guī)格說明； 軟件版本說明等。,本標(biāo)準(zhǔn)將給出這些文檔的編制規(guī)范，同時(shí)，本標(biāo)準(zhǔn)也是這些文檔的編寫質(zhì)量的檢驗(yàn)準(zhǔn)則。一般地說，一個(gè)軟件總是一個(gè)計(jì)算機(jī)系統(tǒng)（包括硬件，固件和軟件）的組成部分。鑒于計(jì)算機(jī)系統(tǒng)的多樣性，本標(biāo)準(zhǔn)一般不涉及整個(gè)系統(tǒng)開發(fā)中的文檔編制問題，本標(biāo)準(zhǔn)僅僅是軟件開發(fā)過程中的文檔編制指南。 對(duì)于使用文檔的人員而言他們所關(guān)心的文件的種類隨他們所承擔(dān)的工作而異。,管理人員： 可行性分析（研究）報(bào)告， 項(xiàng)目開發(fā)計(jì)劃， 軟件配置管理計(jì)劃， 軟件質(zhì)量保證計(jì)劃， 開發(fā)進(jìn)度月報(bào)， 項(xiàng)目開發(fā)總結(jié)報(bào)告；,開發(fā)人員： 可行性分析（研究）報(bào)告， 項(xiàng)目開發(fā)計(jì)劃， 軟件需求規(guī)格說明， 接口需求規(guī)格說明， 軟件（結(jié)構(gòu)）設(shè)計(jì)說明， 接口設(shè)計(jì)說明書， 數(shù)據(jù)庫（頂層）設(shè)計(jì)說明， 測試計(jì)劃， 測試報(bào)告；,維護(hù)人員： 軟件需求規(guī)格說明， 接口需求規(guī)格說明， 軟件（結(jié)構(gòu)）設(shè)計(jì)說明， 測試報(bào)告，,用 戶： 軟件產(chǎn)品規(guī)格說明， 軟件版本說明， 用戶手冊(cè)， 操作手冊(cè)。 本標(biāo)準(zhǔn)規(guī)定了在軟件開發(fā)過程中文檔編制的要求，這些文檔從使用的角度可分為用戶文檔和開發(fā)文檔兩大類。其中，用戶文檔必須交給用戶。用戶應(yīng)該得到的文檔的種類和規(guī)模由供應(yīng)者與用戶之間簽訂的合同規(guī)定。,如前所述，軟件，從出現(xiàn)一個(gè)構(gòu)思之日起，經(jīng)過軟件開發(fā)成功投入使用，直到最后決定停止使用并被另一項(xiàng)軟件代替之時(shí)止，被認(rèn)為是該軟件的一個(gè)生存周期，一般地說這個(gè)軟件生存周期可以分成以下六個(gè)階段：,可行性與計(jì)劃研究階段； 需求分析階段； 設(shè)計(jì)階段； 實(shí)現(xiàn)階段； 測試階段； 運(yùn)行與維護(hù)階段。,在可行性分析（研究）與計(jì)劃階段內(nèi)，要確定該軟件的開發(fā)目標(biāo)和總的要求，要進(jìn)行可行性分析、投資一收益分析、制訂開發(fā)計(jì)劃，并完成應(yīng)編制的文檔。 在需求分析階段內(nèi)，由系統(tǒng)分析人員對(duì)被設(shè)計(jì)的系統(tǒng)進(jìn)行系統(tǒng)分析，確定對(duì)該軟件的各項(xiàng)功能、性能需求和設(shè)計(jì)約束，確定對(duì)文檔編制的要求，作為本階段工作的結(jié)果，一般地說軟件需求規(guī)格說明（也稱為：軟件需求說明、軟件規(guī)格說明）、數(shù)據(jù)要求說明和初步的用戶手冊(cè)應(yīng)該編寫出來。,在設(shè)計(jì)階段內(nèi)，系統(tǒng)設(shè)計(jì)人員和程序設(shè)計(jì)人員應(yīng)該在反復(fù)理解軟件需求的基礎(chǔ)上，提出多個(gè)設(shè)計(jì)，分析每個(gè)設(shè)計(jì)能履行的功能并進(jìn)行相互比較，最后確定一個(gè)設(shè)計(jì)，包括該軟件的結(jié)構(gòu)、模塊（或CSCI）的劃分、功能的分配，以及處理流程。在被設(shè)計(jì)系統(tǒng)比較復(fù)雜的情況下，設(shè)計(jì)階段應(yīng)分解成概要設(shè)計(jì)階段和詳細(xì)設(shè)計(jì)階段兩個(gè)步驟。在一般情況下，應(yīng)完成的文檔包括：結(jié)構(gòu)設(shè)計(jì)說明、詳細(xì)設(shè)計(jì)說明和測試計(jì)劃初稿。,在實(shí)現(xiàn)階段內(nèi)，要完成源程序的編碼、編譯（或匯編）和排錯(cuò)調(diào)試得到無語法錯(cuò)的程序清單，要開始編寫進(jìn)度日?qǐng)?bào)、周報(bào)和月報(bào)（是否要有日?qǐng)?bào)或周報(bào)，取決于項(xiàng)目的重要性和規(guī)模），并且要完成用戶手冊(cè)、操作手冊(cè)等面向用戶的文檔的編寫工作，還要完成測試計(jì)劃的編制。 在測試階段：該程序?qū)⒈蝗娴販y試，已編制的文檔將被檢查審閱。一般要完成測試分析報(bào)告。作為開發(fā)工作的結(jié)束，所生產(chǎn)的程序、文檔以及開發(fā)工作本身將逐項(xiàng)被評(píng)價(jià)，最后寫出項(xiàng)目開發(fā)總結(jié)報(bào)告。,在整個(gè)開發(fā)過程中（即前五個(gè)階段中），開發(fā)團(tuán)隊(duì)要按月編寫開發(fā)進(jìn)度月報(bào)。 在運(yùn)行和維護(hù)階段，軟件將在運(yùn)行使用中不斷地被維護(hù)，根據(jù)新提出的需求進(jìn)行必要而且可能的擴(kuò)充和刪改、更新和升級(jí)。,6.2 文檔編制中的考慮因素,文檔編制是開發(fā)過程的有機(jī)組成部分，也是一個(gè)不斷努力的工作過程。是一個(gè)從形成最初輪廓、經(jīng)反復(fù)檢查和修改，直至程序和文檔正式交付使用的完整過程。其中每一步都要求工作人員做出很大努力。要保證文檔編制的質(zhì)量，要體現(xiàn)每個(gè)開發(fā)項(xiàng)目的特點(diǎn)，也要注意不要花太多的人力。為此編制中要考慮如下各項(xiàng)因素。,6.2.1 文檔的讀者 每一種文檔都具有特定的讀者。這些讀者包括個(gè)人或小組、軟件開發(fā)單位的成員或社會(huì)上的公眾、從事軟件工作的技術(shù)人員、管理人員或領(lǐng)導(dǎo)干部。他們期待著使用這些文檔的內(nèi)容來進(jìn)行工作，例如設(shè)計(jì)、編寫程序、測試、使用、維護(hù)或進(jìn)行計(jì)劃管理。因此這些文檔的作者必須了解自己的讀者。這些文檔的編寫必須注意適應(yīng)自己的特定讀者的水平、特點(diǎn)和要求。,6.2.2 重復(fù)性 本規(guī)范中列出的文檔編制規(guī)范的內(nèi)容要求中，顯然存在某些重復(fù)。較明顯的重復(fù)有兩類。引言是每一種文檔都要包含的內(nèi)容，以向讀者提供總的梗概.第二類明顯的重復(fù)是各種文檔中的說明部分，如對(duì)功能性能的說明；對(duì)輸入、輸出的描述；系統(tǒng)中包含的設(shè)備等。這是為了方便每種文檔各自的讀者，每種文檔應(yīng)該自成體系，盡量避免讀一種文檔時(shí)又不得不去參考另一種文檔。當(dāng)然，在每一種文檔里，有關(guān)引言、說明等同其他文檔相重復(fù)的部分，在行文上、在所用的術(shù)語上、在詳細(xì)的程度上，還是應(yīng)該有一些差別以適應(yīng)各種文檔的不同讀者的需要。,6.2.3 靈活性 鑒于軟件開發(fā)是具有創(chuàng)造性的腦力勞動(dòng)，也鑒于不同軟件在規(guī)模上和復(fù)雜程度上差別極大，本規(guī)范認(rèn)為在文檔編制工作中應(yīng)允許一定的靈活性。這種靈活性表現(xiàn)在如下各款。,a. 應(yīng)編制的文檔種類 盡管本規(guī)范認(rèn)為在一般情況下，一項(xiàng)軟件的開發(fā)過程中，應(yīng)產(chǎn)生如上所述的各種文檔，然而針對(duì)一項(xiàng)具體的軟件開發(fā)項(xiàng)目，有時(shí)不必編制這么多的文檔，可以把幾種文檔合并成一種。一般地說，當(dāng)項(xiàng)目的規(guī)模、復(fù)雜性和失敗風(fēng)險(xiǎn)增大時(shí)，文檔編制的范圍，管理手續(xù)和詳細(xì)程度將隨之增加，反之，則可適當(dāng)減少。為了恰當(dāng)?shù)卣莆者@種靈活性，本規(guī)范要求貫徹分工負(fù)責(zé)的原則，這意味著：,1） 一個(gè)軟件開發(fā)單位的領(lǐng)導(dǎo)機(jī)構(gòu)應(yīng)該根據(jù)本單位經(jīng)營承包的應(yīng)用軟件的專業(yè)領(lǐng)域和本單位的管理能力，制定一個(gè)對(duì)文檔編制要求的實(shí)施規(guī)定，主要是：在不同的條件下，應(yīng)該形成哪些文檔？這些文檔的詳細(xì)程度？該開發(fā)單位的每一個(gè)項(xiàng)目負(fù)責(zé)人，必須認(rèn)真執(zhí)行這個(gè)實(shí)施規(guī)定。,2） 對(duì)于一個(gè)具體的應(yīng)用軟件項(xiàng)目，項(xiàng)目負(fù)責(zé)人應(yīng)根據(jù)上述實(shí)施規(guī)定，確定一個(gè)文檔編制計(jì)劃（可以包含在軟件開發(fā)計(jì)劃中），其中包括：,（1） 應(yīng)該編制哪幾種文檔，詳細(xì)程度如何？ (2) 各個(gè)文檔的編制負(fù)責(zé)人和進(jìn)度要求； (3) 審查、批準(zhǔn)的負(fù)責(zé)人和時(shí)間進(jìn)度安排 (4) 在開發(fā)時(shí)間內(nèi)，各文檔的維護(hù)、修改和 管理的負(fù)責(zé)人，以及批準(zhǔn)手續(xù)。 每項(xiàng)工作必須落實(shí)到人。 這個(gè)文件編制計(jì)劃是整個(gè)開發(fā)計(jì)劃的重要組成部份。 3） 有關(guān)的設(shè)計(jì)人員則必須嚴(yán)格執(zhí)行這個(gè)文檔編制計(jì)劃。,b. 文檔的詳細(xì)程度 從同一份提綱起草的文件的篇幅大小往往不同，可以少到幾頁，也可以長達(dá)幾百頁。對(duì)于這種差別，本規(guī)范是允許的。此詳細(xì)程度取決于任務(wù)的規(guī)模、復(fù)雜性和項(xiàng)目負(fù)責(zé)人對(duì)該軟件的開發(fā)過程及運(yùn)行環(huán)境所需要的詳細(xì)程度的判斷。,c. 文檔的擴(kuò)展 當(dāng)被開發(fā)系統(tǒng)的規(guī)模非常大例如源碼超過一百萬行時(shí)，一種文檔可以分成幾卷編寫，可以按其中每一個(gè)系統(tǒng)分別編制；也可以按內(nèi)容劃分成多卷，例如： 項(xiàng)目開發(fā)計(jì)劃可能包括： 質(zhì)量保證計(jì)劃， 配置管理計(jì)劃， 用戶培訓(xùn)計(jì)劃， 安裝實(shí)施計(jì)劃；,系統(tǒng)設(shè)計(jì)說明可分寫成： 系統(tǒng)設(shè)計(jì)說明， 子系統(tǒng)設(shè)計(jì)說明； 程序設(shè)計(jì)說明可分寫成： 程序設(shè)計(jì)說明， 接口設(shè)計(jì)說明， 版本說明；,操作手冊(cè)可分寫成： 操作手冊(cè)， 安裝實(shí)施過程； 測試計(jì)劃可分寫成： 測試計(jì)劃， 測試設(shè)計(jì)說明， 測試規(guī)程， 測試用例；,測試分析報(bào)告可分寫成： 綜合測試報(bào)告， 驗(yàn)收測試報(bào)告； 項(xiàng)目開發(fā)總結(jié)報(bào)告亦可分寫成項(xiàng)目開發(fā)總結(jié)報(bào)告和資源環(huán)境統(tǒng)計(jì)。,d. 節(jié)的擴(kuò)張與縮并 在有些文檔中，可以使用本規(guī)范所提供的章、條標(biāo)題，有存在一系列需要分別討論的因素。本規(guī)范認(rèn)為，所有的條都可以擴(kuò)展，可以進(jìn)一步細(xì)分，以適應(yīng)實(shí)際需要。反之如果章條中的有些細(xì)節(jié)并非必需，也可以根據(jù)實(shí)際情況縮并。此時(shí)章條的編號(hào)應(yīng)相應(yīng)地變更。,e. 程序設(shè)計(jì)的表現(xiàn)形式 本規(guī)范對(duì)于程序的設(shè)計(jì)表現(xiàn)形式并未作出規(guī)定或限制，可以使用流程圖的形式，判定表的形式，也可以使用其他表現(xiàn)形式，如程序設(shè)計(jì)語言（PDL）、問題分析圖（PALb）等。 f. 文檔的表現(xiàn)形式 本規(guī)范對(duì)于文檔的表現(xiàn)形式亦未作出規(guī)定或限制?？梢允褂米匀徽Z言，也可以使用形式化語言。也可以使用各件圖、表。,七、文檔編制格式,7.1 可行性分析（研究）報(bào)告（FAR）,說明： 1. 可行性分析（研究）報(bào)告（FAR）它是項(xiàng)目初期策劃的結(jié)果，它分析了項(xiàng)目的要求、目標(biāo)和環(huán)境；提出了幾種可供選擇的方案；并從技術(shù)、經(jīng)濟(jì)和法律各方面進(jìn)行了可行性分析?？勺鳛轫?xiàng)目決策的依據(jù)。 2. FAR也可以作為項(xiàng)目建議書、投標(biāo)書等文件的基礎(chǔ)。,1 引言 本章分為以下幾條。 1.1 標(biāo)識(shí) 本條應(yīng)包含本文檔適用的系統(tǒng)和軟件的完整標(biāo)識(shí)，（若適用）包括標(biāo)識(shí)號(hào)、標(biāo)題、縮略詞語、版本號(hào)和發(fā)行號(hào)。 1.2 背景 說明項(xiàng)目在什么條件下提出，提出者的要求、目標(biāo)、實(shí)現(xiàn)環(huán)境和限制條件。,1.3 項(xiàng)目概述 本條應(yīng)簡述本文檔適用的項(xiàng)目和軟件的用途，它應(yīng)描述項(xiàng)目和軟件的一般特性；概述項(xiàng)目開發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識(shí)項(xiàng)目的投資方、需方、用戶、開發(fā)方和支持機(jī)構(gòu)；標(biāo)識(shí)當(dāng)前和計(jì)劃的運(yùn)行現(xiàn)場；列出其它有關(guān)的文檔。 1.4 文檔概述 本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與其使用有關(guān)的保密性和私密性的要求。,2 引用文檔 本章應(yīng)列出本文檔引用的所有文檔的編號(hào)、標(biāo)題、修訂版本和日期，本章也應(yīng)標(biāo)識(shí)不能通過正常的供貨渠道獲得的所有文檔的來源。,3 可行性分析的前提 3.1 項(xiàng)目的要求 3.2 項(xiàng)目的目標(biāo) 3.3 項(xiàng)目的環(huán)境、條件、假定和限制 3.4 進(jìn)行可行性分析的方法,4 可選的方案 4.1 原有方案的優(yōu)缺點(diǎn)、局限性及存在的問題 4.2 可重用的系統(tǒng)，與要求之間的差距 4.3 可選擇的系統(tǒng)方案1 4.4 可選擇的系統(tǒng)方案2 4.5 選擇最終方案的準(zhǔn)則。,5 所建議的系統(tǒng) 5.1 對(duì)所建議的系統(tǒng)的說明 5.2 數(shù)據(jù)流程和處理流程 5.3 與原系統(tǒng)的比較（若有原系統(tǒng)）,5.4 影響（或要求） 5.4.1 設(shè)備 5.4.2 軟件 5.4.3 運(yùn)行 5.4.4 開發(fā) 5.4.5 環(huán)境 5.4.6 經(jīng)費(fèi) 5.5 局限性,6 經(jīng)濟(jì)可行性（成本效益分析） 6.1 投資：包括基本建設(shè)投資（如開發(fā)環(huán)境、設(shè)備、軟件和資料等），其他一次性和非一次性投資（如技術(shù)管理費(fèi)、培訓(xùn)費(fèi)、管理費(fèi)、人員工資、獎(jiǎng)金和差旅費(fèi)等）。,6.2 預(yù)期的經(jīng)濟(jì)效益 6.2.1 一次性收益 6.2.2 非一次性收益 6.2.3 不可定量的收益 6.2.4 收益投資比 6.2.5 投資回收周期 6.3 市場預(yù)測,7 技術(shù)可行性（技術(shù)風(fēng)險(xiǎn)評(píng)價(jià)） 本公司現(xiàn)有資源（如人員、環(huán)境、設(shè)備和技術(shù)條件等）能否滿足此工程和項(xiàng)目實(shí)施要求，若不滿足，應(yīng)考慮補(bǔ)救措施（如需要分承包方參與、增加人員、投資和設(shè)備等），涉及經(jīng)濟(jì)問題應(yīng)進(jìn)行投資、成本和效益可行性分析，最后確定此工程和項(xiàng)目是否具備技術(shù)可行性。 8 法律可行性 系統(tǒng)開發(fā)可能導(dǎo)致的侵權(quán)、違法和責(zé)任。,9 用戶使用可行性 用戶單位的行政管理和工作制度；使用人員的素質(zhì)和培訓(xùn)要求。 10 其它與項(xiàng)目有關(guān)的問題 未來可能的變化。,11 注解 本章應(yīng)包含有助于理解本文檔的一般信息（例如原理）。本章應(yīng)包含為理解本文檔需要的術(shù)語和定義，并給出解釋；所有縮略詞語和它們?cè)谖臋n中的含義的字母序列表。 附錄 附錄可用來提供那些為便于文檔維護(hù)而單獨(dú)出版的信息（例如圖表、分類數(shù)據(jù)）。（若適用）在提供資料的文檔主體部分應(yīng)當(dāng)引用附錄。為便于處理，附錄可單獨(dú)裝訂成冊(cè)。附錄應(yīng)按字母順序（A，B等）編排。,7.2 軟件開發(fā)計(jì)劃（SDP）,說明： 1. 軟件開發(fā)計(jì)劃（SDP）描述開發(fā)者實(shí)施軟件開發(fā)工作的計(jì)劃，本文檔中”軟件開發(fā)”一詞涵蓋了新開發(fā)、修改、重用、再工程、維護(hù)和由軟件產(chǎn)品引起的其它所有的活動(dòng)。 2. SDP是向需求方提供了解和監(jiān)督軟件開發(fā)過程、所使用的方法、每項(xiàng)活動(dòng)的途徑、項(xiàng)目的安排、組織及資源的一種手段。 3. 本計(jì)劃的某些部分可視實(shí)際需要單獨(dú)編制成冊(cè)，例如，軟件配置管理計(jì)劃、軟件質(zhì)量保證計(jì)劃和文檔編制計(jì)劃等。,1 引言 本章分為以下幾條。 1.1 標(biāo)識(shí) 本條應(yīng)包含本文檔適用的系統(tǒng)和軟件的完整標(biāo)識(shí)，（若適用）包括標(biāo)識(shí)號(hào)、標(biāo)題、縮略詞語、版本號(hào)和發(fā)行號(hào)。 1.2 系統(tǒng)概述 本條應(yīng)簡述本文檔適用的系統(tǒng)和軟件的用途，它應(yīng)描述系統(tǒng)和軟件的一般特性；概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識(shí)項(xiàng)目的投資方、需方、用戶、開發(fā)方和支持機(jī)構(gòu)；標(biāo)識(shí)當(dāng)前和計(jì)劃的運(yùn)行現(xiàn)場；列出其它有關(guān)的文檔。,1.3 文檔概述 本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與其使用有關(guān)的保密性和私密性的要求。 1.4 與其它計(jì)劃之間的關(guān)系 （若有）本條描述本計(jì)劃和其它項(xiàng)目管理計(jì)劃的關(guān)系。 1.5 基線 給出編寫本項(xiàng)目開發(fā)計(jì)劃的輸入基線，如軟件需求規(guī)格說明。,2 引用文檔 本章應(yīng)列出本文檔引用的所有文檔的編號(hào)、標(biāo)題、修訂版本和日期，本章也應(yīng)標(biāo)識(shí)不能通過正常的供貨渠道獲得的所有文檔的來源。,3 交付產(chǎn)品 3.1 程序 3.2 文檔 3.3 服務(wù) 3.4 非移交產(chǎn)品 3.5 驗(yàn)收標(biāo)準(zhǔn) 3.6 最后交付期限 列出本項(xiàng)目應(yīng)交付的產(chǎn)品，包括軟件產(chǎn)品和文檔。其中，軟件產(chǎn)品應(yīng)指明哪些是要開發(fā)的，哪些是屬于維護(hù)性質(zhì)的；文檔是指隨軟件產(chǎn)品交付給用戶的技術(shù)文檔，例如用戶手冊(cè)、安裝手冊(cè)等。,4 所需工作概述 本章根據(jù)需要分條對(duì)后續(xù)章描述的計(jì)劃作出說明，（若適用）包括以下概述： a. 對(duì)所要開發(fā)系統(tǒng)、軟件的需求和約束； b. 對(duì)項(xiàng)目文檔編制的需求和約束； c. 該項(xiàng)目在系統(tǒng)生命周期中所處的地位； d. 所選用的計(jì)劃/采購策略或?qū)λ鼈兊男枨蠛图s束； e. 項(xiàng)目進(jìn)度安排及資源的需求和約束； f. 其它的需求和約束，如：項(xiàng)目的安全性、保密性、私密性、方法、標(biāo)準(zhǔn)、硬件開發(fā)和軟件開發(fā)的相互依賴關(guān)系等。,5 實(shí)施整個(gè)軟件開發(fā)活動(dòng)的計(jì)劃 本章分以下幾條。不需要的活動(dòng)的條款用”不適用”注明，如果對(duì)項(xiàng)目中不同的開發(fā)階段或不同的軟件需要不同的計(jì)劃，這些不同之處應(yīng)在此條加以注解。除以下規(guī)定的內(nèi)容外，每條中還應(yīng)標(biāo)識(shí)可適用的風(fēng)險(xiǎn)和不確定因素，和處理它們的計(jì)劃。,5.1 軟件開發(fā)過程 本條應(yīng)描述要采用的軟件開發(fā)過程。計(jì)劃應(yīng)覆蓋論及它的所有合同條款，確定已計(jì)劃的開發(fā)階段（適用的話）、目標(biāo)、和各階段要執(zhí)行的軟件開發(fā)活動(dòng)。 5.2 軟件開發(fā)總體計(jì)劃 本條應(yīng)分以下若干條進(jìn)行描述。,5.2.1 軟件開發(fā)方法 本條應(yīng)描述或引用要使用的軟件開發(fā)方法，包括為支持這些方法所使用的手工、自動(dòng)工具和過程的描述。該方法應(yīng)覆蓋論及它的所有合同條款。如果這些方法在它們所適用的活動(dòng)范圍有更好的描述，可引用本計(jì)劃的其它條。,5.2.2 軟件產(chǎn)品標(biāo)準(zhǔn) 本條應(yīng)描述或引用在表達(dá)需求、設(shè)計(jì)、編碼、測試用例、測試過程和測試結(jié)果方面要遵循的標(biāo)準(zhǔn)。標(biāo)準(zhǔn)應(yīng)覆蓋合同中論及它的所有條款。如果這些標(biāo)準(zhǔn)在標(biāo)準(zhǔn)所適用的活動(dòng)范圍有更好的描述，可引用在本計(jì)劃中的其它條。對(duì)要使用的各種編程語言都應(yīng)提供編碼標(biāo)準(zhǔn)，至少應(yīng)包括：,a. 格式標(biāo)準(zhǔn)（如：縮進(jìn)、空格、大小寫和信息的排序）； b. 首部注釋標(biāo)準(zhǔn)，例如（要求：代碼的名稱/標(biāo)識(shí)符，版本標(biāo)識(shí)，修改歷史，用途）需求和實(shí)現(xiàn)的設(shè)計(jì)決策，處理的注記（例如：使用的算法、假設(shè)、約束、限制和副作用），數(shù)據(jù)注記（輸入、輸出、變量和數(shù)據(jù)結(jié)構(gòu)等）； c. 其它注釋標(biāo)準(zhǔn)（例如要求的數(shù)量和預(yù)期的內(nèi)容）； d. 變量、參數(shù)、程序包、過程和文檔等的命名約定； e.（若有）編程語言構(gòu)造或功能的使用限制； f. 代碼聚合復(fù)雜性的制約。,5.2.3 可重用的軟件產(chǎn)品 本條應(yīng)分以下若干條。 5.2.3.1 吸納可重用的軟件產(chǎn)品 本條應(yīng)描述標(biāo)識(shí)、評(píng)估和吸納可重用軟件產(chǎn)品要遵循的方法，包括搜尋這些產(chǎn)品的范圍和進(jìn)行評(píng)估的準(zhǔn)則。描述應(yīng)覆蓋合同中論及它的所有條款。在制定或更新計(jì)劃時(shí)對(duì)己選定的或候選的可重用的軟件產(chǎn)品應(yīng)加以標(biāo)識(shí)和說明，（若適用）同時(shí)應(yīng)給出與使用有關(guān)的優(yōu)點(diǎn)、缺陷和限制。,5.2.3.2 開發(fā)可重用的軟件產(chǎn)品 本條應(yīng)描述如何標(biāo)識(shí)、評(píng)估和報(bào)告開發(fā)可重用軟件產(chǎn)品的機(jī)會(huì)。描述應(yīng)覆蓋合同中論及它的所有條款。,5.2.4 處理關(guān)鍵性需求 本條應(yīng)分以下若干條描述為處理指定關(guān)鍵性需求應(yīng)遵循的方法。描述應(yīng)覆蓋合同中論及它的所有條款。 5.2.4.1 安全性保證 5.2.4.2 保密性保證 5.2.4.3 私密性保證 5.2.4.4 其它關(guān)鍵性需求保證,5.2.5 計(jì)算機(jī)硬件資源利用 本條應(yīng)描述分配計(jì)算機(jī)硬件資源和監(jiān)控其使用情況要遵循的方法。描述應(yīng)覆蓋合同中論及它的所有條款。 5.2.6 記錄原理 本條應(yīng)描述記錄原理所遵循的方法，該原理在支持機(jī)構(gòu)對(duì)項(xiàng)目作出關(guān)鍵決策時(shí)是有用的。應(yīng)對(duì)項(xiàng)目的”關(guān)鍵決策”一詞作出解釋，并陳述原理記錄在什么地方。描述應(yīng)覆蓋合同中論及它的所有條款。,5.2.7 需方評(píng)審?fù)緩?本條應(yīng)描述為評(píng)審軟件產(chǎn)品和活動(dòng)，讓需方或授權(quán)代表訪問開發(fā)方和分承制方的一些設(shè)施要遵循的方法。描述應(yīng)遵循合同中論及它的所有條款。,6 實(shí)施詳細(xì)軟件開發(fā)活動(dòng)的計(jì)劃 本章分條進(jìn)行描述。不需要的活動(dòng)用”不適用”注明，如果項(xiàng)目的不同的開發(fā)階段或不同的軟件需要不同的計(jì)劃，則在本條應(yīng)指出這些差異。每項(xiàng)活動(dòng)的論述應(yīng)包括應(yīng)用于以下方面的途徑（方法/過程/工具）：1）所涉及的分析性任務(wù)或其它技術(shù)性任務(wù)：2）結(jié)果的記錄：3）與交付有關(guān)的準(zhǔn)備（如果有的話）。論述還應(yīng)標(biāo)識(shí)存在的風(fēng)險(xiǎn)和不確定因素，及處理它們的計(jì)劃。如果適用的方法在5.2.1處描述了的話，可引用它。,6.1 項(xiàng)目計(jì)劃和監(jiān)督 本條分成若干分條描述項(xiàng)目計(jì)劃和監(jiān)督中要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.1.1 軟件開發(fā)計(jì)劃（包括對(duì)該計(jì)劃的更新） 6.1.2 CSCI測試計(jì)劃 6.1.3 系統(tǒng)測試計(jì)劃 6.1.4 軟件安裝計(jì)劃 6.1.5 軟件移交計(jì)劃 6.1.6 跟蹤和更新計(jì)劃，包括評(píng)審管理的時(shí)間間隔,6.2 建立軟件開發(fā)環(huán)境 本條分成以下若干分條描述建立、控制、維護(hù)軟件開發(fā)環(huán)境所遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.2.1 軟件工程環(huán)境 6.2.2 軟件測試環(huán)境 6.2.3 軟件開發(fā)庫 6.2.4 軟件開發(fā)文檔 6.2.5 非交付軟件,6.3 系統(tǒng)需求分析 6.3.1 用戶輸入分析 6.3.2 運(yùn)行概念 6.3.3 系統(tǒng)需求 6.4 系統(tǒng)設(shè)計(jì) 6.4.1 系統(tǒng)級(jí)設(shè)計(jì)決策 6.4.2 系統(tǒng)體系結(jié)構(gòu)設(shè)計(jì),6.5 軟件需求分忻 本條描述軟件需求分析中要遵循的方法。應(yīng)覆蓋合同中論及它的所有條款。 6.6 軟件設(shè)計(jì) 本條應(yīng)分成若干分條描述軟件設(shè)計(jì)中所遵循的方法.各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.6.1 CSCI級(jí)設(shè)計(jì)決策 6.6.2 CSCI體系結(jié)構(gòu)設(shè)計(jì) 6.6.3 CSCI詳細(xì)設(shè)計(jì),6.7 軟件實(shí)現(xiàn)和配置項(xiàng)測試 本條應(yīng)分成若干分條描述軟件實(shí)現(xiàn)配置項(xiàng)測試中要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.7.1 軟件實(shí)現(xiàn) 6.7.2 配置項(xiàng)測試準(zhǔn)備 6.7.3 配置項(xiàng)測試執(zhí)行 6.7.4 修改和再測試 6.7.5 配置項(xiàng)測試結(jié)果分析與記錄,6.8 配置項(xiàng)集成和測試 本條應(yīng)分成若干分條描述配置項(xiàng)集成和測試中要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.8.1 配置項(xiàng)集成和測試準(zhǔn)備 6.8.2 配置項(xiàng)集成和測試執(zhí)行 6.8.3 修改和再測試 6.8.4 配置項(xiàng)集成和測試結(jié)果分析與記錄,6.9 CSCI合格性測試 本條應(yīng)分成若干分條描述CSCI合格性測試中要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.9.1 CSCI合格性測試的獨(dú)立性 6.9.2 在目標(biāo)計(jì)算機(jī)系統(tǒng)（或模擬的環(huán)境）上測試 6.9.3 CSCI合格性測試準(zhǔn)備 6.9.4 CSCI合格性測試演練 6.9.5 CSCI合格性測試執(zhí)行 6.9.6 修改和再測試 6.9.7 CSCI合格性測試結(jié)果分析與記錄,6.10 CSCI/HWCI集成和測試 本條應(yīng)分成若干分條描述CSCI/HWCI集成和測試中要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.10.1 CSCI/HWCI集成和測試準(zhǔn)備 6.10.2 CSCI/HWCI集成和測試執(zhí)行 6.10.3 修改和再測試 6.10.4 CSCI/HWCI集成和測試結(jié)果分析與記錄,6.11 系統(tǒng)合格性測試 本條應(yīng)分成若干分條描述系統(tǒng)合格性測試中要遵循的方法。各分條的計(jì)劃應(yīng)遵循合同中論及它的所有條款。 6.11.1 系統(tǒng)合格性測試的獨(dú)立性 6.11.2 在目標(biāo)計(jì)算機(jī)系統(tǒng)（或模擬的環(huán)境）上測試 6.11.3 系統(tǒng)合格性測試準(zhǔn)備 6.11.4 系統(tǒng)合格性測試演練 6.11.5 系統(tǒng)合格性測試執(zhí)行 6.11.6 修改和再測試 6.11.7 系統(tǒng)合格性測試結(jié)果分析與記錄,6.12 軟件使用準(zhǔn)備 本條應(yīng)分成若干分條描述軟件應(yīng)用準(zhǔn)備中要遵循的方法。各分條的計(jì)劃應(yīng)遵循合同中論及它的所有條款。 6.12.1 可執(zhí)行軟件的準(zhǔn)備 6.12.2 用戶現(xiàn)場的版本說明的準(zhǔn)備 6.12.3 用戶手冊(cè)的準(zhǔn)備 6.12.4 在用戶現(xiàn)場安裝,6.13 軟件移交準(zhǔn)備 本條應(yīng)分成若干分條描述軟件移交準(zhǔn)備要遵循的方法。各分條的計(jì)劃應(yīng)遵循合同中論及它的所有條款。 6.13.1 可執(zhí)行軟件的準(zhǔn)備 6.13.2 源文件準(zhǔn)備 6.13.3 支持現(xiàn)場的版本說明的準(zhǔn)備 6.13.4 “已完成”的CSCI設(shè)計(jì)和其它的軟件支持信息的準(zhǔn)備 6.13.5 系統(tǒng)設(shè)計(jì)說明的更新 6.13.6 支持手冊(cè)準(zhǔn)備 6.13.7 到指定支持現(xiàn)場的移交,6.14 軟件配置管理 本條應(yīng)分成若干分條描述軟件配置管理中要遵循的方法。各分條的計(jì)劃應(yīng)遵循合同中論及它的所有條款。 6.14.1 配置標(biāo)識(shí) 6.14.2 配置控制 6.14.3 配置狀態(tài)統(tǒng)計(jì) 6.14.4 配置審核 6.14.5 發(fā)行管理和交付,6.15 軟件產(chǎn)品評(píng)估 本條應(yīng)分成若干分條描述軟件產(chǎn)品評(píng)估中要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.15.1 中間階段的和最終的軟件產(chǎn)品評(píng)估 6.15.2 軟件產(chǎn)品評(píng)估記錄（包括所記錄的具體條目） 6.15.3 軟件產(chǎn)品評(píng)估的獨(dú)立性,6.16 軟件質(zhì)量保證 本條應(yīng)分成若干分條描述軟件質(zhì)量保證中要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.16.1 軟件質(zhì)量保證評(píng)估 6.16.2 軟件質(zhì)量保證記錄、包括所記錄的具體條目 6.16.3 軟件質(zhì)量保證的獨(dú)立性,6.17 問題解決過程（更正活動(dòng)） 本條應(yīng)分成若干分條描述軟件更正活動(dòng)中要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.17.1 問題/變更報(bào)告 它包括要記錄的具體條目（可選的條目包括：項(xiàng)目名稱，提出者，問題編號(hào)，問題名稱，受影響的軟件元素或文檔，發(fā)生日期，類別和優(yōu)先級(jí)，描述，指派的該問題的分析者，指派日期，完成日期，分析時(shí)間，推薦的解決方案，影響，問題狀態(tài)，解決方案的批準(zhǔn)，隨后的動(dòng)作，更正者，更正日期，被更正的版本，更正時(shí)間，己實(shí)現(xiàn)的解決方案的描述）。 6.17.2 更正活動(dòng)系統(tǒng),6.18 聯(lián)合評(píng)審（聯(lián)合技術(shù)評(píng)審和聯(lián)合管理評(píng)審） 本條應(yīng)分成若干分條描述進(jìn)行聯(lián)合技術(shù)評(píng)審和聯(lián)合管理評(píng)審要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.18.1 聯(lián)合技術(shù)評(píng)審包括一組建議的評(píng)審 6.18.2 聯(lián)合管理評(píng)審包括一組建議的評(píng)審,6.19 文檔編制 本條應(yīng)分成若干分條描述文檔編制要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 應(yīng)遵循本標(biāo)準(zhǔn)第5章文檔編制過程中的有關(guān)文檔編制計(jì)劃的規(guī)定執(zhí)行。,6.20 其它軟件開發(fā)活動(dòng) 本條應(yīng)分成若干分條描述進(jìn)行其它軟件開發(fā)活動(dòng)要遵循的方法。各分條的計(jì)劃應(yīng)覆蓋合同中論及它的所有條款。 6.20.1 風(fēng)險(xiǎn)管理，包括己知的風(fēng)險(xiǎn)和相應(yīng)的對(duì)策 6.20.2 軟件管理指標(biāo)，包括要使用的指標(biāo) 6.20.3 保密性和私密性,6.20.4 分承制方管理 6.20.5 與軟件獨(dú)立驗(yàn)證與確認(rèn)（IV&V）機(jī)構(gòu)的接口 6.20.6 和有關(guān)開發(fā)方的協(xié)調(diào) 6.20.7 項(xiàng)目過程的改進(jìn) 6.20.8 計(jì)劃中未提及的其它活動(dòng),7 進(jìn)度表和活動(dòng)網(wǎng)絡(luò)圖 本章應(yīng)給出： a. 進(jìn)度表，標(biāo)識(shí)每個(gè)開發(fā)階段中的活動(dòng)，給出每個(gè)活動(dòng)的初始點(diǎn)、提交的草稿和最終結(jié)果的可用性，和其它的里程碑及每個(gè)活動(dòng)的完成點(diǎn)； b. 活動(dòng)網(wǎng)絡(luò)圖，描述項(xiàng)目活動(dòng)之間的順序關(guān)系和依賴關(guān)系，標(biāo)出完成項(xiàng)目中有最嚴(yán)格時(shí)間限制的活動(dòng)。,8 項(xiàng)目組織和資源 本章應(yīng)分成若干分條描述各階段要使用的項(xiàng)目組織和資源。 8.1 項(xiàng)目組織 本條應(yīng)描述本項(xiàng)目要采用的組織結(jié)構(gòu)，包括涉及的組織機(jī)構(gòu)、機(jī)構(gòu)之間的關(guān)系、執(zhí)行所需活動(dòng)的每個(gè)機(jī)構(gòu)的權(quán)限和職責(zé)。,8.2 項(xiàng)目資源 本條應(yīng)描述適用于本項(xiàng)目的資源。（若適用）應(yīng)包括： a.人力資源，包括； 1）估計(jì)此項(xiàng)目應(yīng)投入的人力（人員/時(shí)間數(shù)）； 2）按職責(zé)（如：管理，軟件工程，軟件測試，軟件配置管理，軟件產(chǎn)品評(píng)估，軟件質(zhì)量保證和軟件文檔編制等）分解所投入的人力； 3）履行每個(gè)職責(zé)人員的技術(shù)級(jí)別、地理位置和涉密程度的劃分；,b. 開發(fā)人員要使用的設(shè)施，包括執(zhí)行工作的地理位置、要使用的設(shè)施、保密區(qū)域和運(yùn)用合同項(xiàng)目的設(shè)施的其它特性； c. 為滿足合同需要，需方應(yīng)提高的設(shè)備、軟件、服務(wù)、文檔、資料及設(shè)施，給出一張何時(shí)需要上述各項(xiàng)的進(jìn)度表； d. 其它所需的資源，包括：獲得資源的計(jì)劃、需要的日期和每項(xiàng)資源的可用性。,9 培訓(xùn) 9.1 項(xiàng)目的技術(shù)要求 根據(jù)客戶需求和項(xiàng)目策劃結(jié)果，確定本項(xiàng)目的技術(shù)要求，包括管理技術(shù)和開發(fā)技術(shù)。 9.2 培訓(xùn)計(jì)劃 根據(jù)項(xiàng)目的技術(shù)要求和項(xiàng)目成員的情況，確定是否需要進(jìn)行項(xiàng)目培訓(xùn)，并制訂培訓(xùn)計(jì)劃。如不需要培訓(xùn)，應(yīng)說明理由。,10 項(xiàng)目估算 說明項(xiàng)目估算的結(jié)果。 10.1 規(guī)模估算 10.2 工作量估算 10.3 成本估算 10.4 關(guān)鍵計(jì)算機(jī)資源估算 10.5 管理預(yù)留,11 風(fēng)險(xiǎn)管理 分析可能存在的風(fēng)險(xiǎn)，所采取的對(duì)策和風(fēng)險(xiǎn)管理計(jì)劃。 12 支持條件 12.1 計(jì)算機(jī)系統(tǒng)支持。 12.2 需要需方承擔(dān)的工作和提供的條件。 12.3 需要分包商承擔(dān)的工作和提供的條件。,13 注解 本章應(yīng)包含有助于理解本文檔的一般信息（例如原理）。本章應(yīng)包含為理解本文檔需要的術(shù)語和定義并給出解釋，所有縮略詞語和它們?cè)谖臋n中的含義的字母序列表。 附錄 附錄可用來提供那些為便于文檔維護(hù)而單獨(dú)出版的信息（例如圖表、分類數(shù)據(jù)）。（若適用）在提供資料的文檔主體部分應(yīng)當(dāng)引用附錄。為便于處理，附錄可單獨(dú)裝訂成冊(cè)。附錄應(yīng)按字母順序（A，B等）編排。,7.11 軟件需求規(guī)格說明（SRS）,說明： 1. 軟件需求規(guī)格說明（SRS）描述對(duì)計(jì)算機(jī)軟件配置項(xiàng)CSCI的需求，及確保每個(gè)要求得以滿足的所使用的方法.涉及該CSCI外部接口的需求可在本SRS中給出：或在本SRS引用的一個(gè)或多個(gè)接口需求規(guī)格說明（IRS）中給出。 2. 這個(gè)SRS，可能還要用IRS加以補(bǔ)充，是CSCI設(shè)計(jì)與合格性測試的基礎(chǔ)。,1 范圍 本章應(yīng)分為以下幾條。 1.1 標(biāo)識(shí) 本條應(yīng)包含本文檔適用的系統(tǒng)和軟件的完整標(biāo)識(shí)，（若適用）包括標(biāo)識(shí)號(hào)、標(biāo)題、縮略詞語、版本號(hào)和發(fā)行號(hào)。 1.2 系統(tǒng)概述 本條應(yīng)簡述本文檔適用的系統(tǒng)和軟件的用途，它應(yīng)描述系統(tǒng)和軟件的一般特性；概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識(shí)項(xiàng)目的投資方、需方、用戶、開發(fā)方和支持機(jī)構(gòu)；標(biāo)識(shí)當(dāng)前和計(jì)劃的運(yùn)行現(xiàn)場；列出其它有關(guān)的文檔。,1.3 文檔概述 本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與其使用有關(guān)的保密性或私密性要求。 1.4 基線 說明編寫本系統(tǒng)設(shè)計(jì)說明書所依據(jù)的設(shè)計(jì)基線。 2 引用文檔 本章應(yīng)列出本文檔引用的所有文檔的編號(hào)、標(biāo)題、修訂版本和發(fā)行日期，也應(yīng)標(biāo)識(shí)不能通過正常的供貨渠道獲得的所有文檔的來源。,3 需求 本章應(yīng)分以下幾條描述CSCI需求，也就是，構(gòu)成CSCI驗(yàn)收條件的CSCI的特性。CSCI需求是為了滿足分配給該CSCI的系統(tǒng)需求所形成的的軟件需求。給每個(gè)需求指定項(xiàng)目唯一標(biāo)識(shí)符以支持測試和可追蹤性。并以一種可以定義客觀測試的方式來陳述需求。如果每個(gè)需求有關(guān)的合格性方法（見第4章）和對(duì)系統(tǒng)（若適用，子系統(tǒng)）需求的可追蹤性（見5.a條）在相應(yīng)的章中沒有提供，則在此進(jìn)行注解。,描述的詳細(xì)程度遵循以下規(guī)則：應(yīng)包含構(gòu)成CSCI驗(yàn)收條件的那些CSCI特性，需方愿意推遲到設(shè)計(jì)時(shí)留給開發(fā)方說明的那些特性。如果在給定條中沒有需求的話，本條應(yīng)如實(shí)陳述。如果某個(gè)需求在多條中出現(xiàn)，可以只陳述一次而在其它條直接引用。,3.1 所需的狀態(tài)和方式 如果需要CSCI在多種狀態(tài)和方式下運(yùn)行，且不同狀態(tài)和方式具有不同的需求的話，則要標(biāo)識(shí)和定義每一狀態(tài)和方式，狀態(tài)和方式的例子包括：空閑、準(zhǔn)備就緒、活動(dòng)、事后分析、培訓(xùn)、降級(jí)、緊急情況和后備等。狀態(tài)和方式的區(qū)別是任意的，可以僅用狀態(tài)描述CSCI，也可以僅用方式、方式中的狀態(tài)、狀態(tài)中的方式或其它有效方式描述。如果不需要多個(gè)狀態(tài)和方式，不需人為加以區(qū)分，應(yīng)如實(shí)陳述；如果需要多個(gè)狀態(tài)或方式，還應(yīng)使本規(guī)格說明中的每個(gè)需求或每組需求與這些狀態(tài)和方式相關(guān)聯(lián)，關(guān)聯(lián)可在本條或本條引用的附錄中用表格或其它的方法表示，也可在需求出現(xiàn)的地方加以注解。,3.2 需求概述 3.2.1 目標(biāo) a. 本系統(tǒng)的開發(fā)意圖、應(yīng)用目標(biāo)及作用范圍（現(xiàn)有產(chǎn)品存在的問題和建議產(chǎn)品所要解決的問題）。 b. 本系統(tǒng)的主要功能、處理流程、數(shù)據(jù)流程及簡要說明。 c. 表示外部接口和數(shù)據(jù)流的系統(tǒng)高層次圖。說明本系統(tǒng)與其他相關(guān)產(chǎn)品的關(guān)系，是獨(dú)立產(chǎn)品還是一個(gè)較大產(chǎn)品的組成部分（可用方框圖說明）。,3.2.2 運(yùn)行環(huán)境 簡要說明本系統(tǒng)的運(yùn)行環(huán)境（包括硬件環(huán)境和支持環(huán)境）的規(guī)定。 3.2.3 用戶的特點(diǎn) 說明是那一種類型的用戶，從使用系統(tǒng)來說，有些什么特點(diǎn)。 3.2.4 關(guān)鍵點(diǎn) 說明本軟件需求規(guī)格說明書中的關(guān)鍵點(diǎn)（例如：關(guān)鍵功能、關(guān)鍵算法和所涉及的關(guān)鍵技術(shù)等）。,3.2.5 約束條件 列出進(jìn)行本系統(tǒng)開發(fā)工作的約束條件。例如：經(jīng)費(fèi)限制、開發(fā)期限和所采用的方法與技術(shù)，以及政治、社會(huì)、文化、法律等。,3.3 需求規(guī)格 3.3.1 軟件系統(tǒng)總體功能對(duì)象結(jié)構(gòu) 對(duì)軟件系統(tǒng)總體功能對(duì)象結(jié)構(gòu)進(jìn)行描述，包括結(jié)構(gòu)圖、流程圖或?qū)ο髨D。 3.3.2 軟件子系統(tǒng)功能對(duì)象結(jié)構(gòu) 對(duì)每個(gè)主要子系統(tǒng)中的基本功能模塊對(duì)象進(jìn)行描述，包括結(jié)構(gòu)圖、流程圖或?qū)ο髨D。 3.3.3 描述約定 通常使用的約定描述（數(shù)學(xué)符號(hào)、度量單位等）。,3.4 CSCI能力需求 本條應(yīng)分條詳細(xì)描述與CSCI每一能力相關(guān)聯(lián)的需求?！澳芰Α北欢x為一組相關(guān)的需求?？梢杂谩肮δ堋薄ⅰ靶阅堋?、“主題”、“目標(biāo)”、或其它適合用來表示需求的詞來替代“能力”。,3.4.x （CSCI能力） 本條應(yīng)標(biāo)識(shí)必需的每一個(gè)CSCI能力，并詳細(xì)說明與該能力有關(guān)的需求。如果該能力可以更清晰地分解成若干子能力，則應(yīng)分條對(duì)子能力進(jìn)行說明。該需求應(yīng)指出所需的CSCI行為，包括適用的參數(shù)，如響應(yīng)時(shí)間、吞吐時(shí)間、其它時(shí)限約束、序列、精度、容量（大小/多少）、優(yōu)先級(jí)別、連續(xù)運(yùn)行需求、和基于運(yùn)行條件的允許偏差：（若適用）需求還應(yīng)包括在異常條件、非許可條件或越界條件下所需的行為，錯(cuò)誤處理需求和任何為保證在緊急時(shí)刻運(yùn)行的連續(xù)性而引入到CSCI中的規(guī)定。在確定與CSCI所接收的輸入和CSCI所產(chǎn)生的輸出有關(guān)的需求時(shí)，應(yīng)考慮在本文3.5.x給出要考慮的主題列表。,對(duì)于每一類功能或者對(duì)于每一個(gè)功能，需要具體描寫其輸入、處理和輸出的需求。 a. 說明 描述此功能要達(dá)到的目標(biāo)、所采用的方法和技術(shù)，還應(yīng)清楚說明功能意圖的由來和背景。 b. 輸入 包括： 1）詳細(xì)描述該功能的所有輸入數(shù)據(jù)，如：輸入源、數(shù)量、度量單位、時(shí)間設(shè)定和有效輸入范圍等。 2）指明引用的接口說明或接口控制文件的參考資料。,c. 處理 定義對(duì)輸入數(shù)據(jù)、中間參數(shù)進(jìn)行處理以獲得預(yù)期輸出結(jié)果的全部操作。包括： 1）輸入數(shù)據(jù)的有效性檢查。 2）操作的順序，包括事件的時(shí)間設(shè)定。 3）異常情況的響應(yīng)，例如，溢出、通信故障、錯(cuò)誤處理等。 4）受操作影響的參數(shù)。 5）用于把輸入轉(zhuǎn)換成相應(yīng)輸出的方法。 6）輸出數(shù)據(jù)的有效性檢查。,d. 輸出 1）詳細(xì)說明該功能的所有輸出數(shù)據(jù)，例如，輸出目的地、數(shù)量、度量單位、時(shí)間關(guān)系、有效輸出范圍、非法值的處理、出錯(cuò)信息等。 2）有關(guān)接口說明或接口控制文件的參考資料。,3.5 CSCI外部接口需求 本條應(yīng)分條描述CSCI外部接口的需求。（如有）本條可引用一個(gè)或多個(gè)接口需求規(guī)格說明（IRS）或包含這些需求的其它文檔。 外部接口需求，應(yīng)分別說明： a. 用戶接口； b. 硬件接口； c. 軟件接口； d. 通信接口的需求。,3.5.1 接口標(biāo)識(shí)和接口圖 本條應(yīng)標(biāo)識(shí)所需的CSCI外部接口，也就是CSCI和與它共享數(shù)據(jù)、向它提供數(shù)據(jù)或與它交換數(shù)據(jù)的實(shí)體的關(guān)系。（若適用）每個(gè)接口標(biāo)識(shí)應(yīng)包括項(xiàng)目唯一標(biāo)識(shí)符，并應(yīng)用名稱、序號(hào)、版本和引用文檔指明接口的實(shí)體（系統(tǒng)、配置項(xiàng)、用戶等）。該標(biāo)識(shí)應(yīng)說明哪些實(shí)體具有固定的接口特性（因而要對(duì)這些接口實(shí)體強(qiáng)加接口需求），哪些實(shí)體正被開發(fā)或修改（從而接口需求已施加給它們）?？捎靡粋€(gè)或多個(gè)接口圖來描述這些接口。,3.5.x （接口的項(xiàng)目唯一標(biāo)識(shí)符） 本條（從3.5.2開始）應(yīng)通過項(xiàng)目唯一標(biāo)識(shí)符標(biāo)識(shí)CSCI的外部接口，簡單地標(biāo)識(shí)接口實(shí)體，根據(jù)需要可分條描述為實(shí)現(xiàn)該接口而強(qiáng)加于CSCI的需求。該接口所涉及的其它實(shí)體的接口特性應(yīng)以假設(shè)或“當(dāng)（未提到實(shí)體）這樣做時(shí)，CSCI將”的形式描述，而不描述為其它實(shí)體的需求。本條可引用其它文檔（如：數(shù)據(jù)字典、通信協(xié)議標(biāo)準(zhǔn)、用戶接口標(biāo)準(zhǔn)）代替在此所描述的信息。（若適用）需求應(yīng)包括下列