版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認領(lǐng)
文檔簡介
1、.GB 856788軟件開發(fā)主要文檔編寫規(guī)范本附錄中列出了計算機軟件產(chǎn)品開發(fā)文件編制指南GB 856788中主要軟件文檔的編寫說明,供編寫時參考。這些文檔主要是:可行性研究報告、項目開發(fā)計劃、軟件需求說明書、概要設(shè)計說明書、詳細設(shè)計說明書、模塊開發(fā)卷宗、測試計劃、測試分析報告、項目開發(fā)總結(jié)報告。一、 可行性研究報告l 引言1.1 編寫目的說明:說明本可行性研究報告的編寫目的,指出預期的讀者。1.2 背景說明:a所建議開發(fā)的軟件系統(tǒng)的名稱。b本項目的任務(wù)提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機網(wǎng)絡(luò)。c該軟件系統(tǒng)同其他系統(tǒng)或其他機構(gòu)的基本的相互來往關(guān)系。1.3 定義列出本文件中用到的專門
2、術(shù)語的定義和外文首字母組詞的原詞組。1.4 參考資料列出用得著的參考資料,如:a本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文。b屬干本項目的其他已發(fā)表的文件。c. 本文件中各處引用的文件、資料,包括所需用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。2 可行性研究的前提說明對建議開發(fā)項目進行可行性研究的前提,如要求、目標、條件、假定和限制等。 2.1 要求說明對所建議開發(fā)軟件的基本要求,如: a功能。 b性能。 c輸出如報告、文件或數(shù)據(jù),對每項輸出要說明其特征,如用途、產(chǎn)生頻度、接口以及分發(fā)對象。 d. 輸入說明。系統(tǒng)的輸入包括數(shù)據(jù)
3、的來源、類型、數(shù)量、數(shù)據(jù)的組織以及提供的頻度。 e處理流程和數(shù)據(jù)流程。用圖表的方式表示出最基本的數(shù)據(jù)流程和處理流程,并輸之以敘述。 f. 在安全與保密方面的要求。 g. 同本系統(tǒng)相連接的其他系統(tǒng)。 h. 完成期限。2.2 目標說明所建議系統(tǒng)的主要開發(fā)目標,如:a. 人力與設(shè)備費用的減少。b. 處理速度的提高。c. 控制精度或生產(chǎn)能力的提高。d管理信息服務(wù)的改進。e. 自動決策系統(tǒng)的改進。f. 人員利用率的改進。2.3 條件、假定和限制說明對這項開發(fā)中給出的條件、假定和所受到的限制,如a. 所建議系統(tǒng)的運行壽命的最小值。b. 進行系統(tǒng)方案選擇比較的時間。c. 經(jīng)費、投資方面的來源和限制。d. 法
4、津和政策方面的限制。e. 硬件、軟件、運行環(huán)境和開發(fā)環(huán)境方面的條件和限制。f. 可利用的信息和資源。g. 系統(tǒng)投入使用的最晚時間。2.4 進行可行性研究的方法說明這項可行性研究將是如何進行的,所建議的系統(tǒng)將是如何評價的。摘要說明所使用的基本方法和策略,如調(diào)查、加權(quán)、確定模型、建立基準點或仿真等。2.5 評價尺度說明對系統(tǒng)進行評價時所使用的主要尺度如費用的多少、各項功能的優(yōu)先次序、開發(fā)時間的長短及使用中的難易程度。3 對現(xiàn)有系統(tǒng)的分析這里的現(xiàn)有系統(tǒng)是指當前實際使用的系統(tǒng)。這個系統(tǒng)可能是計算機系統(tǒng),也可能是一個機械系統(tǒng)甚至是一個人工系統(tǒng)。分析現(xiàn)有系統(tǒng)的目的是為了進一步闡明建議中的開發(fā)新系統(tǒng)或修改現(xiàn)
5、有系統(tǒng)的必要性。3.l 處理流程和數(shù)據(jù)流程說明現(xiàn)有系統(tǒng)的基本處理流程和數(shù)據(jù)流程。此流程可用圖表即流程圖的形式表示,并加以敘述。 3.2 工作負荷 列出現(xiàn)有系統(tǒng)所承擔的工作及工作量。 3.3 費用開支 列出由于運行現(xiàn)有系統(tǒng)所引起的費用開支,如人力、設(shè)備、空間、支持性服務(wù)、材料等項開支以及開支總額。 3.4 人員 列出為了現(xiàn)有系統(tǒng)的運行和維護所需要的人員的專業(yè)技術(shù)類別和數(shù)量。 3.5 設(shè)備 列出現(xiàn)有系統(tǒng)所使用的各種設(shè)備。3.6 局限性 列出本系統(tǒng)的主要的局限性,例如處理時間趕不上需要,響應(yīng)不及時,數(shù)據(jù)存儲能力不足。處理功能不夠等。并且要說明,為什么對現(xiàn)有系統(tǒng)的改進維護已經(jīng)不能解決問題。4 所建議的
6、系統(tǒng)本章將用來說明所建議系統(tǒng)的目標和要求將如何被滿足。4.l 對所建議系統(tǒng)的說明概括地說明所建議系統(tǒng),并說明在第2節(jié)中列出的那些要求將如何得到滿足,說明所使用的基本方法及理論根據(jù)。4.2 處理流程和數(shù)據(jù)流程給出所建議系統(tǒng)的處理流程和數(shù)據(jù)流程4.3 改進之處按2節(jié)中列出的目標,逐項說明所建議系統(tǒng)相對于現(xiàn)存系統(tǒng)具有的改進。4.4 影響說明在建立所建議系統(tǒng)時,預期將帶來的影響,包括:4.4.1 對設(shè)備的影響說明新提出的設(shè)備要求及對現(xiàn)存系統(tǒng)中尚可使用的設(shè)備需作的修改。 4.4.2 對軟件的影響說明為了使現(xiàn)存的應(yīng)用軟件和支持軟件能夠同所建議系統(tǒng)相適應(yīng)。而需要對這些軟件所進行的修改和補充。 4.4.3 對
7、用戶單位機構(gòu)的影響說明為了建立和運行所建議系統(tǒng),對用戶單位機構(gòu)、人員的數(shù)量和技術(shù)水平等方面的全部要求。4.4.4 對系統(tǒng)運行過程的影響說明所建議系統(tǒng)對運行過程的影響,如:a用戶的操作規(guī)程。b. 運行中心的操作規(guī)程。c. 運行中心與用戶之間的關(guān)系。d. 源數(shù)據(jù)的處理。e. 數(shù)據(jù)進入系統(tǒng)的過程。f. 對數(shù)據(jù)保存的要求,對數(shù)據(jù)存儲、恢復的處理。g. 輸出報告的處理過程、存儲媒體和調(diào)度方法。h. 系統(tǒng)失效的后果及恢復的處理辦法。4.4.5 對開發(fā)的影響說明對開發(fā)的影響,如:a. 為了支持所建議系統(tǒng)的開發(fā)用戶需進行的工作。b. 為了建立一個數(shù)據(jù)庫所要求的數(shù)據(jù)資源。c. 為了開發(fā)和測驗所建議系統(tǒng)而需要的計
8、算機資源。d. 所涉及的保密與安全問題。4.4.6 對地點和設(shè)施的影響說明對建筑物改造的要求及對環(huán)境設(shè)施的要求。4.4.7 對經(jīng)費開支的影響扼要說明為了所建議系統(tǒng)的開發(fā),設(shè)計和維持運行而需要的各項經(jīng)費開支。4.5 局限性說明所建議系統(tǒng)尚存在的局限性以及這些問題未能消除的原因。4.6 技術(shù)條件方面的可行性本節(jié)應(yīng)說明技術(shù)條件方面的可行性,如:a在當前的限制條件下,該系統(tǒng)的功能目標能否達到。b. 利用現(xiàn)有的技術(shù),該系統(tǒng)的功能能否實現(xiàn)。c. 對開發(fā)人員的數(shù)量和質(zhì)量的要求并說明這些要求能否滿足。d. 在規(guī)定的期限內(nèi),本系統(tǒng)的開發(fā)能否完成。5 可選擇的其他系統(tǒng)方案扼要說明曾考慮過的每一種可選擇的系統(tǒng)方案,
9、包括需開發(fā)的和從國內(nèi)國外直接購買的,如果沒有供選擇的系統(tǒng)方案可考慮,則說明這一點。5.1 可選擇的系統(tǒng)方案1參照第 4節(jié)的提綱說明可選擇的系統(tǒng)方案 1,并說明它未被選中的理由。5.2 可選擇的系統(tǒng)方案2按類似5.1條的方式說明第2個乃至第N個可選擇的系統(tǒng)方案。6 投資及效益分析6.1 支出對于所選擇的方案,說明所需的費用。如果已有一個現(xiàn)存系統(tǒng),則包括該系統(tǒng)繼續(xù)運行期間所需的費用。6.l.1 基本建設(shè)投資包括采購、開發(fā)和安裝下列各項所需的費用,如:a. 房屋和設(shè)施。b. ADP設(shè)備。c. 數(shù)據(jù)通訊設(shè)備。d. 環(huán)境保護設(shè)備。e. 安全與保密設(shè)備。fADP操作系統(tǒng)和應(yīng)用的軟件。g. 數(shù)據(jù)庫管理軟件。
10、6.1.2 其他一次性支出包括下列各項所需的費用,如:a. 研究(需求的研究和設(shè)計的研究)。b. 開發(fā)計劃與測量基準的研究。c. 數(shù)掘庫的建立。d. ADP軟件的轉(zhuǎn)換。e. 檢查費用和技術(shù)管理性費用。f. 培訓費、旅差費以及開發(fā)安裝人員所需要的一次性支出。g. 人員的退休及調(diào)動費用等。6.1.3 非一次性支出列出在該系統(tǒng)生命期內(nèi)按月或按季或按年支出的用于運行和維護的費用,包括:a. 設(shè)備的租金和維護費用。b. 軟件的租金和維護費用。c. 數(shù)據(jù)通訊方面的租金和維護費用。d. 人員的工資、獎全。e. 房屋、空間的使用開支。f. 公用設(shè)施方面的開支。g. 保密安全方面的開支。h. 其他經(jīng)常性的支出等
11、。6.2 收益對于所選擇的方案,說明能夠帶來的收益,這里所說的收益,表現(xiàn)為開支費用的減少或避免、差錯的減少、靈活性的增加、動作速度的提高和管理計劃方面的改進等,包括:6.2.1 一次性收益說明能夠用人民幣數(shù)目表示的一次性收益,可按數(shù)據(jù)處理、用戶、管理和支持等項分類敘述,如:a. 開支的縮減包括改進了的系統(tǒng)的運行所引起的開支縮減,如資源要求的減少,運行效率的改進,數(shù)據(jù)進入、存貯和恢復技術(shù)的改進,系統(tǒng)性能的可監(jiān)控,軟件的轉(zhuǎn)換和優(yōu)化,數(shù)據(jù)壓縮技術(shù)的采用,處理的集中化/分布化等。b. 價值的增升包括由于一個應(yīng)用系統(tǒng)的使用價值的增升所引起的收益,如資源利用的改進管理和運行效率的改進以及出錯率的減少等。c
12、其他如從多余設(shè)備出售回收的收入等。6.2.2 非一次勝收益說明在整個系統(tǒng)生命期內(nèi)由于運行所建議系統(tǒng)而導致的按月的、按年的能用人民幣數(shù)目表示的收益,包括開支的減少和避免。6.2.3 不可定量的收益逐項列出無法直接用人民幣表示的收益,如服務(wù)的改進,由操作失誤引起的鳳險的減少,信息掌握情況的改進,組織機構(gòu)給外界形象的改善等。有些不可捉摸的收益只能大概估計或進行極值估計(按最好和最差情況估計)。6.3 收益/投資比求出整個系統(tǒng)生命期的收益/投資比值。6.4 投資回收周期 求出收益的累計數(shù)開始超過支出的累計數(shù)的時間。6.5 敏感性分析所謂敏感性分析是指一些關(guān)鍵性因素如系統(tǒng)生命期長度、系統(tǒng)的工作負荷量、工
13、作負荷的類型與這些不同類型之間的合理搭配、處理速度要求、設(shè)備和軟件的配置等變化時,對開支和收益的影響最靈敏的范圍的估計。在敏感性分析的基礎(chǔ)上做出的選擇當然會比單一選擇的結(jié)果要好一些。7 社會因素方面的可行性本節(jié)用來說明對社會因素方面的可行性分析的結(jié)果,包括:7.l 法律方面的可行性法律方面的可行性問題增多,如合同責任、侵犯專利權(quán)、侵犯版權(quán)等方面的陷阱,軟件人員通常是不熟悉的,有可能陷入,務(wù)必要注意研究。 7.2 使用方面的可行性例如從用戶單位的行政管理、工作制度等方面來看,是否能夠使用該軟件系統(tǒng);從用戶單位的工作人員的素質(zhì)來看,是否能滿足使用該軟件系統(tǒng)的要求等等,都是要考慮。8 結(jié)論在進行可行
14、性研究報告的編制時,必須有一個研究的結(jié)論。結(jié)論可以是:a可以立即開始進行。b需要推遲到某些條件(例如資金、人力、設(shè)備等)落實之后才能開始進行。c. 需要對開發(fā)目標進行某些修改之后才能開始進行。d不能進行或不必進行(例如因技術(shù)不成熟、經(jīng)濟上不合算等)。二、 項目開發(fā)計劃l 引言1.1 編寫目的說明編寫這份項目開發(fā)計劃的目的并指出預期的讀者。1.2 背景說明: a待開發(fā)軟件系統(tǒng)的名稱。b本項目的任務(wù)提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機網(wǎng)絡(luò)。c. 該軟件系統(tǒng)同其他系統(tǒng)或其他機構(gòu)的基本的相互來往關(guān)系。1.3 定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4 參考資斜列
15、出用得著的參考資料,如:a本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文。b屬于本項目的其他已發(fā)表的文件。c. 本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。2. 項目概述2.1 工作內(nèi)客簡要地說明在本項目的開發(fā)中需進行的各項主要工作。2.2 主要參加人員扼要說明參加本項目開發(fā)工作的主要人員的情況,包括他們的技術(shù)水平。2.3 產(chǎn)品2.3.1 程序列出需移交給用戶的程序的名稱、所用的編程語言及存儲程序的媒體形式。并通過引用有關(guān)文件,逐項說明其功能和能力。2.3.2 文件列出需移交給用戶的每種文件的
16、名稱及內(nèi)容要點。2.3.3 服務(wù)列出需向用戶提供的各項服務(wù)。如培訓安裝、維護和運行支持等。應(yīng)逐項規(guī)定開始日期、所提供支持的級別和服務(wù)的期限。2.3.4 非移交的產(chǎn)品說明開發(fā)集體應(yīng)向本單位交出但不必向用戶移交的產(chǎn)品(文件甚至某些程序)。2.4 驗收標準對于上述這些應(yīng)交出的產(chǎn)品和服務(wù),逐項說明或引用資料說明驗收標準。2.5 完成項目的推遲期限2.6 本計劃的批準者和批準日期3. 實施計劃3.1 工作任務(wù)的分工與人員分工對于項目開發(fā)中需完成的各項工作,從需求分析、設(shè)計、實現(xiàn)、測試直到維護,包括文件的編制、審批、打印、分發(fā)工作,用戶培訓工作,軟件安裝工作等,按層次進行分解,指明每項任務(wù)的負責人和參加人
17、員。3.2 接口人員說明負責接口工作的人員及他們的職責,包括:a負責本項目同用戶的接口人員。b負責本項目同本單位各管理機構(gòu),如合同計劃管理部門、財務(wù)部門、質(zhì)量管理部門等的接口人員。c. 負責本項目同各分合同負責單位的接口人員等。3.3 進度對于需求分析、設(shè)計、編碼實現(xiàn)、測試、移交、培訓和安裝等工作,給出每項工作任務(wù)的預定開始日期、完成日期及所需資源,規(guī)定各項工作任務(wù)完成的先后順序以及表征每項工作任務(wù)完成的標志性事件(即所謂的“里程碑”)。3.4 預算逐項列出本開發(fā)項目所需要的勞務(wù)(包括人員的數(shù)量和時間)以及經(jīng)費的預算(包括辦公費、差旅費、機時費、資料費、通訊設(shè)備和專用設(shè)備的租金等)和來源。3.
18、5 關(guān)健問題逐項列出能夠影響整個項目成敗的關(guān)鍵問題、技術(shù)難點和風險,指出這些同題對項目的影響。4. 支持條件說明為支持本項目的開發(fā)所需要的各種條件和設(shè)施。4.1 計算機系統(tǒng)支持逐項列出開發(fā)中和運行時所需的計算機系統(tǒng)支持,包括計算機、外圍設(shè)備、通訊設(shè)備、模擬器、編譯(或匯編)程序、操作系統(tǒng)、數(shù)據(jù)管理程序包、數(shù)據(jù)存儲能力和測試支持能力等,逐項列出有關(guān)到貨日期、使用時間的要求。4.2 需由用戶承擔的工作逐項列出需要用戶承擔的工作和完成期限。包括需由用戶提供的條件及提供時間。4.3 由外單位提供的條件逐項列出需要外單位分合同承包者承擔的工作和完成的時間,包括需要由外單位提供的條件和提供的時間。5. 專
19、題計劃要點說明本項目開發(fā)中需制訂的各個專題計劃(如分合同計劃、開發(fā)人員培訓計劃、測試計劃、安全保密計劃、質(zhì)量保證計劃、配置管理計劃、用戶培訓計劃、系統(tǒng)安裝計劃等的要點。三、 軟件需求說明書l 引言1.1 編寫目的說明編寫這份軟件需求說明書的目的,指出預期的讀者。1.2 背景說明:a待開發(fā)的軟件系統(tǒng)的名稱。b. 本項目的任務(wù)提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機網(wǎng)絡(luò)。c該軟件系統(tǒng)同其他系統(tǒng)或其他機構(gòu)的基本的相互來住關(guān)系。1.3 定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4 參考資斜列出用得著的參考資料,如:a本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文。b
20、屬于本項目的其他已發(fā)表的文件。c. 本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。2 任務(wù)概述 2.1 目標敘述該項軟件開發(fā)的意圖、應(yīng)用目標、作用范圍以及其他應(yīng)向讀者說明的有關(guān)該軟件開發(fā)的背景材料。解釋被開發(fā)軟件與其他有關(guān)軟件之間的關(guān)系。如果本軟件產(chǎn)品是一項獨立的軟件,而且全部內(nèi)容自含,則說明這一點。如果所定義的產(chǎn)品是一個更大的系統(tǒng)的一個組成部分,則應(yīng)說明本產(chǎn)品與該系統(tǒng)中其他各組成部分之間的關(guān)系,為此可使用一張方框圖來說明該系統(tǒng)的組成和本產(chǎn)品同其他各部分的聯(lián)系和接口。2.2 用戶的特點列出本軟件的
21、最終用戶的特點,充分說明操作人員、維護人員的教育水平和技術(shù)專長,以及本軟件的預期使用頻度。這些是軟件設(shè)計工作的重要約束。2.3 假定和約束列出進行本軟件開發(fā)工作的假定和約束,例如經(jīng)費限制、開發(fā)期限等。3 需求規(guī)定3.1 對功能的規(guī)定用列表的方式(例如,IPO表即輸入、處理、輸出表的形式),逐項定量和定性地敘述對軟件所提出的功能要求,說明輸入什么量經(jīng)怎樣的處理、得到什么輸出,說明軟件應(yīng)支持的終端數(shù)和應(yīng)支持的并行操作的用戶數(shù)。 3.2 對性能的規(guī)定 3.2.1 精度說明對該軟件的輸入、輸出數(shù)據(jù)精度的要求,可能包括傳輸過程中的精度。 3.2.2 時間特性要求說明對于該軟件的時間特性要求,如對: a.
22、 響應(yīng)時間。 b. 更新處理時間。c. 數(shù)據(jù)的轉(zhuǎn)換和傳送時間。d. 解題時間等的要求。3.2.3 靈活性說明對該軟件的靈活性的要求,即當需求發(fā)生某些變化時,該軟件對這些變化的適應(yīng)能力,如:a. 作方式上的變化。b. 運行環(huán)境的變化。c. 同其他軟件的接口的變化。d. 精度和有效時限的變化。e計劃的變化或改進。f. 對于為了提供這些靈活性而進行的專門設(shè)計的部分應(yīng)該加以標明。3.3 輸入輸出要求解釋各輸入輸出數(shù)據(jù)類型,并逐項說明其媒體、格式、數(shù)值范圍、精度等。對軟件的數(shù)據(jù)輸出及必須標明的控制輸出量進行解釋并舉例,包括對硬拷貝報告(正常結(jié)果輸出、狀態(tài)輸出及異常輸出)以及圖形或顯示報告的描述。3.4
23、數(shù)據(jù)管理能力要求說明需要管理的文卷和記錄的個數(shù)、表和文卷的大小規(guī)模,要按可預見的增長對數(shù)據(jù)及其分量的存儲要求做出估算。3.5 故障處理要求列出可能的軟件、硬件故障以及對各項性能而言所產(chǎn)生的后果和對故障處理的要求。 3.6 其它專門要求如用戶單位對安全保密的要求,對使用方便的要求,對可維護性、可補充性、易讀性、可靠性、運行環(huán)境可轉(zhuǎn)換性的特殊要求等。4 運行環(huán)境規(guī)定4.l 設(shè)備列出運行該軟件所需要的硬設(shè)備。說明其中的新型設(shè)備及其專門功能,包括:a. 處理器型號及內(nèi)存容量。b. 外存容量、聯(lián)機或脫機、媒體及其存儲格式,設(shè)備的型號及數(shù)量。c. 輸入及輸出設(shè)備的型號和數(shù)量,聯(lián)機或脫機。d. 數(shù)據(jù)通信設(shè)備
24、的型號和數(shù)量。e. 功能鍵及其他專用硬件。4.2 支持軟件列出支持軟件,包括要用到的操作系統(tǒng)、編譯(或匯編)程序、測試支持軟件等。4.3 接口說明該軟件同其他軟件之間的接口、數(shù)據(jù)通信協(xié)議等。4.4 控制說明控制該軟件的運行的方法和控制信號并說明這些控制信號的來源。四、 概要設(shè)計說明書l 引言1.1 編寫目的說明編寫這份概要設(shè)計說明書的目的,指出預期的讀者。1.2 背景說明:a待開發(fā)的軟件系統(tǒng)的名稱。b. 本項目的任務(wù)提出者、開發(fā)者、用戶及運行該軟件的計算中心或計算機網(wǎng)絡(luò)。1.3 定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4 參考資斜列出用得著的參考資料,如:a本項目的經(jīng)
25、核準的計劃任務(wù)書或合同、上級機關(guān)的批文。b屬于本項目的其他已發(fā)表的文件。c. 本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。2 總體設(shè)計2.1 需求規(guī)定說明對本系統(tǒng)的主要的輸入輸出項目、處理的功能性能要求。2.2 運行環(huán)境簡要說明對本系統(tǒng)的運行環(huán)境(包括硬件環(huán)境和支持環(huán)境)的規(guī)定。 2.3 基本設(shè)計概念和處理流程說明本系統(tǒng)的基本設(shè)計概念和處理流程,盡量使用圖表的形式。 2.4 結(jié)構(gòu)用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)元素(各層模塊、子程序、公用程序等)的劃分,扼要說明每個系統(tǒng)元素的標識符和功能,分
26、層次地給出各元素之間的控制與被控制關(guān)系。2.5 功能需求與程序的關(guān)系本條用一張如下的矩陣圖說明各項功能需求的實現(xiàn)同各塊程序的分配關(guān)系,如表2.1所示。表2.1 各項功能需求功能的實現(xiàn)與各塊程序的分配關(guān)系功能需求程序1程序2程序m功能需求1功能需求2功能需求n2.6 人工處理過程說明在本軟件系統(tǒng)的工作過程中不得不包含的人工處理過程(如果有的話)。 2.7 尚未解決的問題說明概要設(shè)計過程中尚未解決而設(shè)計者認為在系統(tǒng)完成之前必須解決的各個問題。3. 接口設(shè)計 3.1 用戶接口說明將向用戶提供的命令和它們的語法結(jié)構(gòu),以及軟件的回答信息。 3.2 外部接口說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之
27、間的接口、本系統(tǒng)與各支持軟件之間的接口關(guān)系。 3.3 內(nèi)部接口說明本系統(tǒng)之內(nèi)的各個系統(tǒng)元素之間的接口的安排。4 運行設(shè)計4.1 運行模塊組合說明對系統(tǒng)施加不同的外界運行控制時所引起的各種不同的運行模塊組合,說明每種運行所歷經(jīng)的內(nèi)部模塊和支持軟件。 4.2 運行控制 說明每一種外界的運行控制的方式方法和操作步驟。 4.3 運行時間說明每種運行模塊組合將占用各種資源的時間。5 系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計 5.1 邏輯結(jié)構(gòu)設(shè)計要點給出本系統(tǒng)內(nèi)所使用的每個數(shù)據(jù)結(jié)構(gòu)的名稱、標識符以及它們之中每個數(shù)據(jù)項、記錄、文卷和系的標識、定義、長度及它們之間的層次的或表格的相互關(guān)系。 5.2 物理結(jié)構(gòu)設(shè)計要點給出本系統(tǒng)內(nèi)所使用
28、的每個數(shù)據(jù)結(jié)構(gòu)中的每個數(shù)據(jù)項的存儲要求,訪問方法、存取單位、存取的物理關(guān)系(索引、設(shè)備、存儲區(qū)域)、設(shè)計考慮和保密條件。 5.3 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系說明各個數(shù)據(jù)結(jié)構(gòu)與訪問這些數(shù)據(jù)結(jié)構(gòu)的形式,如表2.2所示。表2.2 各個數(shù)據(jù)結(jié)構(gòu)與訪問這些數(shù)據(jù)結(jié)構(gòu)的形式功能需求程序1程序2程序m數(shù)據(jù)結(jié)構(gòu)1數(shù)據(jù)結(jié)構(gòu)2數(shù)據(jù)結(jié)構(gòu)n6 系統(tǒng)出錯處理設(shè)計 6.1 出錯信息 用一覽表的方式說明每種可能的出錯或故障情況出現(xiàn)時,系統(tǒng)輸出信息的形式、含意及處理方法。 6.2 補救措施 說明故障出現(xiàn)后可能采取的變通措施,包括: a 后備技術(shù)說明準備采用的后備技術(shù),當原始系統(tǒng)數(shù)據(jù)萬一丟失時啟用的副本的建立和啟動的技術(shù),例如周期性地
29、把磁盤信息記錄到磁帶上去就是對磁盤媒體的一種后備技術(shù)。 b. 降效技術(shù)說明準備采用的后備技術(shù),使用另一個效率稍低的系統(tǒng)或方法來求得所需結(jié)果的某些部分,例如一個自動系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄。 c. 恢復及再啟動技術(shù)說明將使用的恢復再啟動技術(shù),使軟件從故障點恢復執(zhí)行或使軟件從頭開始重新運行的方法。6.3 系統(tǒng)維護設(shè)計說明為了系統(tǒng)維護的方便而在程序內(nèi)部設(shè)計中作出的安排,包括在程序中專門安排用于系統(tǒng)的檢查與維護的檢測點和專用模塊。各個程序之間的對應(yīng)關(guān)系,可采用矩陣圖的形式。五、 詳細設(shè)計說明書l 引言1.1 編寫目的說明編寫這份詳細設(shè)計說明書的目的,指出預期的讀者。1.2 背景說明
30、:a待開發(fā)的軟件系統(tǒng)的名稱。b. 本項目的任務(wù)提出者、開發(fā)者、用戶及運行該軟件的計算中心或計算機網(wǎng)絡(luò)。1.3 定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4 參考資斜列出用得著的參考資料,如:a本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文。b屬于本項目的其他已發(fā)表的文件。c. 本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。2 程序系統(tǒng)的結(jié)構(gòu)用一系列圖表列出本程序系統(tǒng)內(nèi)的每個程序(包括每個模塊和子程序)的名稱、標識符和它們之間的層次結(jié)構(gòu)關(guān)系。3 程序1(標識符)設(shè)計說明從本
31、條開始逐個地給出各個層次中的每個程序的設(shè)計說明。以下給出的提綱是針對一般情況的。對于一個具體的模塊,尤其是層次比較低的模塊或子程序,其很多條目的內(nèi)容往往與它所隸屬的上一層模塊的對應(yīng)條目的內(nèi)容相同,在這種情況下,只要簡單地說明這一點即可。3.1 程序描述給出對該程序的簡單描述,主要說明安排設(shè)計本程序的目的意義,并且,還要說明本程序的特點。如:是常駐內(nèi)存還是非常駐?是否子程序?有無覆蓋要求?是順序處理還是并發(fā)處理等。3.2 功能說明該程序應(yīng)具有的功能,可采用IPO圖(即輸入一處理一輸出圖)的形式。3.3 性能說明對該程序的全部性能要求,包括對精度、靈活性和時間特性的要求。3.4 輸入項給出對每一個
32、輸入項的特性,包括名稱、標識、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來源和安全保密條件等等。3.5 輸出項給出對每一個輸出項的特性,包括名稱、標識、數(shù)據(jù)的類型和格式,數(shù)據(jù)值的有效范圍、輸出的方式。數(shù)量和頻度、輸出媒體、對輸出圖形及符號的說明、安全保密條件等。3.6 算法詳細說明本程序所選用的算法,具體的計算公式和計算步驟。 3.7 流程邏輯用圖表(例如流程圖、判定表等)輔以必要的說明來表示本程序的邏輯流程。3.8 接口用圖的形式說明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序,說明參數(shù)賦值和調(diào)用方式,說明與本程序相直接關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)(數(shù)據(jù)
33、庫、數(shù)據(jù)文卷)。3.9 存儲分配根據(jù)需要,說明本程序的存儲分配。3.10 注釋設(shè)計說明準備在本程序中安排的注釋,如:a. 加在模塊首部的注釋。b. 加在各分枝點處的注釋;對各變量的功能、范圍、缺省條件等所加的注釋。c. 對使用的邏輯所加的注釋等等。3.11 限制條件說明本程序運行中所受到的限制條件。3.12 測試計劃說明對本程序進行單元測試的計劃,包括對測試的技術(shù)要求、輸入數(shù)據(jù)、預期結(jié)果、進度安排、人員職責、設(shè)備條件驅(qū)動程序及模塊等的規(guī)定。3.13 尚未解決的問題說明在本程序的設(shè)計中尚末解決而設(shè)計者認為在軟件完成之前應(yīng)解決的問題。4 程序2(標識符)設(shè)計說明用類似3條的方式,說明第2個程序乃至
34、第N個程序的設(shè)計考慮。六、 模塊開發(fā)卷宗1 標題 a. 軟件系統(tǒng)名稱和標識符。 b. 模塊名稱和標識符(如果本卷宗包含多于一個的模塊,則用這組模塊的功能標識代替模塊名)。 c. 程序編制員簽名。 d. 卷宗的修改文本序號。 e. 修改完成日期。 f卷宗序號(說明本卷宗在整個卷宗中的序號)。 g. 編排日期(說明整個卷宗最近的一次編排日期)。 2 模塊開發(fā)情況表 3 功能說明 扼要說明本模塊(或本組模塊)的功能,主要是輸入、要求的處理、輸出??梢詮南到y(tǒng)設(shè)計說明書中摘錄。同時列出在軟件需求說明書中對這些功能說明的章、條、款。 4 設(shè)計說明 說明本模塊(或本組模塊)的設(shè)計考慮,包括: a在系統(tǒng)設(shè)計說
35、明書中有關(guān)對本模塊(或本組模塊)設(shè)計考慮的敘述,包括本模塊在軟件系統(tǒng)中所處的層次,它同其他模塊的接口。 b. 在程序設(shè)計說明書中有關(guān)對本模塊(或本組模塊)的設(shè)計考慮,包括本模塊的算法、處理流程、牽涉到的數(shù)據(jù)文卷設(shè)計限制、驅(qū)動方式和出錯信息等。 c. 在編制目前已通過全部測試的源代碼時實際使用的設(shè)計考慮。 5 原代瑪清單 要給出所產(chǎn)生的本模塊(或本組模塊)的第一份無語法錯的源代碼清單以及已通過全部測試的當前有效的源代碼清單。 6 測試說明 說明直接要經(jīng)過本模塊(或本組模塊)的每一項測試,包括這些測試各自的標識符和編號、進行這些測試的目的、所用的配置和輸入、預期的輸出及實際的輸出。 7 復審的結(jié)論
36、 把實際測試的結(jié)果,同軟件需求說明書、系統(tǒng)設(shè)計說明書、程序設(shè)計說明書中規(guī)定的要求進行比較和給出結(jié)論。 七、 測試計劃l 引言1.1 編寫目的本測試計劃具體的編寫目的,指出預期的讀者。1.2 背景說明:a. 測試計劃所從屬的軟件系統(tǒng)的名稱。b. 該開發(fā)項目的歷史,列出用戶和執(zhí)行此項目測試的計算中心,說明在開始執(zhí)行本測試計劃之前必須完成的各項工作。1.3 定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4 參考資斜列出用得著的參考資料,如:a本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文。b屬于本項目的其他已發(fā)表的文件。c. 本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)
37、標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。2 計劃 2.1 軟件說明提供一份圖表,并逐項說明被測軟件的功能、輸入和輸出等質(zhì)量指標,作為敘述測試計劃的提綱。 2.2 測試內(nèi)容列出組裝測試和確認測試中的每一項測試內(nèi)容的名稱標識符、這些測試的進度安排以及這些測試的內(nèi)容和目的。例如,模塊功能測試、接口正確性測試、數(shù)據(jù)文卷存取的測試、運行時間的測試、設(shè)計約束和極限的測試等。2.3 測試1(標識符)給出這項測試內(nèi)容的參與單位及被測試的部位。2.3.1 進度安排給出對這項測試的進度安排,包括進行測試的日期和工作內(nèi)容。如:熟悉環(huán)境、培訓、準備輸入數(shù)據(jù)等。2.3
38、.2 條件陳述本項測試工作對資源的要求,包括:a設(shè)備所用到的設(shè)備類型、數(shù)量和預定使用時間。b軟件列出將被用來支持本項測試過程而本身又并不是被測軟件的組成部分的軟件。如測試驅(qū)動程序、測試監(jiān)控程序、仿真程序、樁模塊等等。c. 人員列出在測試工作期間預期可由用戶和開發(fā)任務(wù)組提供的工作人員的人數(shù)。技術(shù)水平及有關(guān)的預備知識,包括一些特殊要求,如倒班操作和數(shù)據(jù)鍵入人員。2.3.3 測試資料列出本項測試所需的資料,如:a有關(guān)本項任務(wù)的文件。b. 被測試程序及其所在的媒體。c. 測試的輸入和輸出舉例。d. 有關(guān)控制此項測試的方法、過程的圖表。2.3.4 測試培訓說明或引用資料說明為被測軟件的使用提供培訓的計劃
39、。規(guī)定培訓的內(nèi)容、受訓的人員及從事培訓的工作人員。2.4 測試2 ( 標識符 )用與本測試計劃2.3條相類似的方式說明用于另一項及其后各項測試內(nèi)容的測試工作計劃。3 測試設(shè)計說明3.1 測試1(標識符)說明對第一項測試內(nèi)容的測試設(shè)計考慮。3.1.l 控制 說明本測試的控制方式,如輸入是人工、半自動或自動引入、控制操作的順序以及結(jié)果的記錄方法。 3.1.2 輸入 說明本項測試中所使用的輸入數(shù)據(jù)及選擇這些輸入數(shù)據(jù)的策略。 3.1.3 輸出 說明預期的輸出數(shù)據(jù),如測試結(jié)果及可能產(chǎn)生的中間結(jié)果或運行信息。 3.l.4 過程說明完成此項測試的一個個步驟和控制命令,包括測試的準備、初始化、中間步驟和運行結(jié)
40、束方式。3.2 測試2(標識符)用與本測試計劃3.1條相類似的方式說明第2項及其后各項測試工作的設(shè)計考慮。 4 評價準則 4.1 范圍 說明所選擇的測試用例能夠檢查的范圍及其局眼性。 4.2 數(shù)據(jù)整理 陳述為了把測試數(shù)據(jù)加工成便于評價的適當形式,使得測試結(jié)果可以同已知結(jié)果進行比較而要用到的轉(zhuǎn)換處理技術(shù)。如手工方式或自動方式;如果是用自動方式整理數(shù)據(jù),還要說明為進行處理而要用到的硬件、軟件資源。4.3 尺度 說明用來判斷測試工作是否能通過的評價尺度,如合理的輸出結(jié)果的類型、測試輸出結(jié)果與預期輸出之間的容許偏離范圍、允許中斷或停機的最大次數(shù)。八、 測試分析報告l 引言1.1 編寫目的說明編寫這份測
41、試分析報告的目的,指出預期的讀者。1.2 背景說明:a. 測試計劃所從屬的軟件系統(tǒng)的名稱。b. 該開發(fā)項目的歷史,列出用戶和執(zhí)行此項目測試的計算中心,指出測試環(huán)境與實際運行環(huán)境之間可能存在的差異以及這些差異對測試結(jié)果的影響。1.3 定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4 參考資斜列出用得著的參考資料,如:a本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文。b屬于本項目的其他已發(fā)表的文件。c. 本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。2 測試概要用表格的形式列出每一項測試的標識符及其測試內(nèi)容,并指明實際進行的測試工作內(nèi)容與測試計劃中預先設(shè)計的內(nèi)容之間的差別,說明做出這種改變的原因。3 測試結(jié)果及發(fā)現(xiàn) 3.1 測試1(標識符)把本項測試中實際得到的動態(tài)輸出(包括內(nèi)部生成數(shù)據(jù)輸出)結(jié)果同對于動態(tài)輸出的要求進行比較,陳述其中的各項發(fā)現(xiàn)。 3.2 測試2(標識符)用類似本報告3.1條的方式給出第2項及其后各項測試內(nèi)容的測試結(jié)果和發(fā)現(xiàn)。4 對軟件功能的結(jié)論4.l 功能1(標識符)4.1.1 能力簡述該項功能,說明為滿足此項功能而設(shè)計的軟件能力以及經(jīng)過一項或多項測試已證實的能力。4.1.2 限制說明測試數(shù)據(jù)值的范圍(包括動態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)),列出就這項功能而言,
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
- 6. 下載文件中如有侵權(quán)或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 海南鋪面租賃合同書電子版
- 合同產(chǎn)生質(zhì)量事故考核
- 2024高考政治一輪復習課時練16中國特色社會主義最本質(zhì)的特征含解析新人教版
- 2024年高考生物二輪復習第一篇專題6考向3生物的進化和生物多樣性學案
- 完美國際黃昏圣殿裝備屬性、所需材料系列介紹(武器篇)投
- 2024購買服務(wù)的合同協(xié)議書
- 2024新疆事業(yè)編制合同到期后單位可以選擇不續(xù)簽
- 2024機動車輛保險合同樣本
- 2024北京市豬肉入市場廠掛鉤合同范本
- 2024消防工程改造合同
- 20200310公園安全風險辨識清單
- 華中科技大學官方信紙
- 60立方油罐容積細表
- WI-QA-02-034A0 燈具成品檢驗標準
- 農(nóng)業(yè)信息技術(shù) chapter5 地理信息系統(tǒng)
- 部編版六年級上語文閱讀技巧及解答
- 斯派克max操作手冊
- 項目四 三人表決器ppt課件
- 結(jié)合子的機械加工工藝規(guī)程及銑槽的夾具設(shè)計
- 林武樟 完整陽宅講義 筆記版[方案]
- 《會滾的汽車》ppt課件
評論
0/150
提交評論