國家標準文檔格式.doc

《國家標準文檔格式.doc》由會員分享，可在線閱讀，更多相關(guān)《國家標準文檔格式.doc（30頁珍藏版）》請在裝配圖網(wǎng)上搜索。

計算機行業(yè)標準化網(wǎng)http://www.nits.gov.cn/jhb/ 軟件設(shè)計文檔國家標準http://www.wendang.com/soft/4727.htm 附錄 國家標準文檔格式 附錄1 可行性研究報告 可行性研究報告的編寫目的是：說明該軟件開發(fā)項目的實現(xiàn)在技術(shù)、經(jīng)濟和社會條件方面的可行性；評述為了合理地達到開發(fā)目標而可能選擇的各種方案；說明并論證所選定的方案。 可行性研究報告的編寫內(nèi)容要求如下： 1. 引言 1.1 編寫目的 說明編寫本可行性研究報告的目的，指出預(yù)期的讀者。 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. 屬于本項目的其他已發(fā)表的文件； c. 本文件中各處引用的文件、資料，包括所需用到的軟件開發(fā)標準。 列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。 2. 可行性研究的前提 說明對所建議的開發(fā)項目進行可行性研究的前提，如要求、目標、假定、限制等。 2.1 要求 說明對所建議開發(fā)的軟件的基本要求，如： a. 功能； b. 性能； c. 輸出如報告、文件或數(shù)據(jù)，對每項輸出要說明其特征，如用途、產(chǎn)生頻度、接口以及分發(fā)對象； d. 輸入說明系統(tǒng)的輸入，包括數(shù)據(jù)的來源、類型、數(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. 法律和政策方面的限制； 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)是指當(dāng)前實際使用的系統(tǒng)，這個系統(tǒng)可能是計算機系統(tǒng)，也可能是一個機械系統(tǒng)甚至是一個人工系統(tǒng)。 分析現(xiàn)有系統(tǒng)的目的是為了進一步闡明建議中的開發(fā)新系統(tǒng)或修改現(xiàn)有系統(tǒng)的必要性。 3.1 處理流程和數(shù)據(jù)流程 說明現(xiàn)有系統(tǒng)的基本的處理流程和數(shù)據(jù)流程。此流程可用圖表即流程圖的形式表示，并加以敘述。 3.2 工作負荷 列出現(xiàn)有系統(tǒng)所承擔(dān)的工作及工作量。 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. 所建議的系統(tǒng) 本章將用來說明所建議系統(tǒng)的目標和要求將如何被滿足。 4.1 對所建議系統(tǒng)的說明 概括地說明所建議系統(tǒng)，并說明在第A．2章中列出的那些要求將如何得到滿足，說明所使用的基本方法及理論根據(jù)。 4.2 處理流程和數(shù)據(jù)流程 給出所建議系統(tǒng)的處理流程和數(shù)據(jù)流程。 4.3 影響 說明在建立所建議系統(tǒng)時，預(yù)期將帶來的影響，包括： 4.4.1 對設(shè)備的影響 說明新提出的設(shè)備要求及對現(xiàn)存系統(tǒng)中尚可使用的設(shè)備須作出的修改。 4.4.2 對軟件的影響 說明為了使現(xiàn)存的應(yīng)用軟件和支持軟件能夠同所建議系統(tǒng)相適應(yīng)。而需要對這些軟件所進行的修改和補充。 4.4.3 對用戶單位機構(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ù)存儲、恢復(fù)的處理； g. 輸出報告的處理過程、存儲媒體和調(diào)度方法； h. 系統(tǒng)失效的后果及恢復(fù)的處理辦法。 4.4.5 對開發(fā)的影響 說明對于開發(fā)的影響，如： a. 為了支持所建議系統(tǒng)的開發(fā)，用戶需進行的工作； b. 為了建立一個數(shù)據(jù)庫所要求的數(shù)據(jù)資源； c. 為了開發(fā)和測驗所建議系統(tǒng)而需要的計算機資源； 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. 在當(dāng)前的限制條件下，該系統(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)方案，包括需開發(fā)的和可從國內(nèi)國外直接購買的，如果沒 有供選擇的系統(tǒng)方案可考慮，則說明這一點。 5.1 可選擇的系統(tǒng)方案1 說明可選擇的系統(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.1.1 基本建設(shè)投資 包括采購、開發(fā)和安裝下列各項所需的費用，如： a. 房屋和設(shè)施； b．ADP設(shè)備； c. 數(shù)據(jù)通訊設(shè)備； d. 環(huán)境保護設(shè)備； e. 安全與保密設(shè)備； f．ADP操作系統(tǒng)的和應(yīng)用的軟件； g. 數(shù)據(jù)庫管理軟件。 6.1.2 其他一次性支出 包括下列各項所需的費用，如： a. 研究（需求的研究和設(shè)計的研究）； b. 開發(fā)計劃與測量基準的研究； c. 數(shù)據(jù)庫的建立； d. ADP軟件的轉(zhuǎn)換； e. 檢查費用和技術(shù)管理性費用； f. 培訓(xùn)費、旅差費以及開發(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)常性的支出等。 6.2 收益 對于所選擇的方案，說明能夠帶來的收益，這里所說的收益，表現(xiàn)為開支費用的減少或避免、差錯的減少、靈活性的增加、動作速度的提高和管理計劃方面的改進等，包括； 6.2.1一次性收益 說明能夠用人民幣數(shù)目表示的一次性收益，可按數(shù)據(jù)處理、用戶、管理和支持等項分類敘述，如： a. 開支的縮減包括改進了的系統(tǒng)的運行所引起的開支縮減，如資源要求的減少，運行效率的改進，數(shù)據(jù)進入、存貯和恢復(fù)技術(shù)的改進，系統(tǒng)性能的可監(jiān)控，軟件的轉(zhuǎn)換和優(yōu)化，數(shù)據(jù)壓縮技術(shù)的采用，處理的集中化／分布化等； b. 價值的增升包括由于一個應(yīng)用系統(tǒng)的使用價值的增升所引起的收益，如資源利用的改進，管理和運行效率的改進以及出錯率的減少等； c. 其他如從多余設(shè)備出售回收的收入等。 6.2.2 非一次性收益 說明在整個系統(tǒng)生命期內(nèi)由于運行所建議系統(tǒng)而導(dǎo)致的按月的、按年的能用人民幣數(shù)目表示的收益，包括開支的減少和避免。 6.2.3 不可定量的收益 逐項列出無法直接用人民幣表示的收益，如服務(wù)的改進，由操作失誤引起的風(fēng)險的減少，信息掌握情況的改進，組織機構(gòu)給外界形象的改善等。有些不可捉摸的收益只能大概估計或進行極值估計（按最好和最差情況估計）。 6.3 收益／投資比 求出整個系統(tǒng)生命期的收益／投資比值。 6.4 投資回收周期 求出收益的累計數(shù)開始超過支出的累計數(shù)的時間。 6.5 敏感性分析 所謂敏感性分析是指一些關(guān)鍵性因素如系統(tǒng)生命期長度、系統(tǒng)的工作負荷量、工作負荷的類型與這些不同類型之間的合理搭配、處理速度要求、設(shè)備和軟件的配置等變化時，對開支和收益的影響最靈敏的范圍的估計。在敏感性分析的基礎(chǔ)上做出的選擇當(dāng)然會比單一選擇的結(jié)果要好一些。 7. 社會因素方面的可行性 本章用來說明對社會因素方面的可行性分析的結(jié)果，包括： 7.1 法律方面的可行性 法律方面的可行性問題很多，如合同責(zé)任、侵犯專利權(quán)、侵犯版權(quán)等方面的陷井，軟件人員通常是不熟悉的，有可能陷入，務(wù)必要注意研究。 7.2 使用方面的可行性 例如從用戶單位的行政管理、工作制度等方面來看，是否能夠使用該軟件系統(tǒng)；從用戶單位的工作人員的素質(zhì)來看，是否能滿足使用該軟件系統(tǒng)的要求等等，都是要考慮的。 8. 結(jié)論 在進行可行性研究報告的編制時，必須有一個研究的結(jié)論。結(jié)論可以是： a. 可以立即開始進行； b. 需要推遲到某些條件（例如資金、人力、設(shè)備等）落實之后才能開始進行； c. 需要對開發(fā)目標進行某些修改之后才能開始進行； d. 不能進行或不必進行（例如因技術(shù)不成熟、經(jīng)濟上不合算等）。 （轉(zhuǎn)載自國家計算機標準和文件模板） 附錄2 項目開發(fā)計劃 編制項目開發(fā)計劃的目的是用文件的形式，把對于在開發(fā)過程中各項工作的負責(zé)人員、開發(fā)進度、所需經(jīng)費預(yù)算、所需軟、硬件條件等問題做出的安排記載下來，以便根據(jù)本計劃開展和檢查本項目的開發(fā)工作。 項目開發(fā)計劃的編制內(nèi)容要求如下： 1. 引言 1.1 編寫目的 說明編寫這份項目開發(fā)計劃的目的，并指出預(yù)期的讀者。 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. 屬于本項目的其他已發(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 文件 列出需移交給用戶的每種文件的名稱及內(nèi)容要點。 2.3.3 服務(wù) 列出需向用戶提供的各項服務(wù)，如培訓(xùn)安裝、維護和運行支持等，應(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ā)工作，用戶培訓(xùn)工作，軟件安裝工作等，按層次進行分解，指明每項任務(wù)的負責(zé)人和參加人員。 3.2 接口人員 說明負責(zé)接口工作的人員及他們的職責(zé)，包括： a. 負責(zé)本項目同用戶的接口人員； b. 負責(zé)本項目同本單位各管理機構(gòu)，如合同計劃管理部門、財務(wù)部門、質(zhì)量管理部門等的接口人員； c. 負責(zé)本項目同各分合同負責(zé)單位的接口人員等。 3.3 進度 對于需求分析、設(shè)計、編碼實現(xiàn)、測試、移交、培訓(xùn)和安裝等工作，給出每項工作任務(wù)的預(yù)。定開始日期、完成日期及所需資源，規(guī)定各項工作任務(wù)完成的先后順序以及表征每項工作任務(wù)完成的標志性事件（即所謂"里程碑"）。 3.4 預(yù)算 逐項列出本開發(fā)項目所需要的勞務(wù)（包括人員的數(shù)量和時間）以及經(jīng)費的預(yù)算（包括辦公費、差旅費、機時費、資料費、通訊設(shè)備和專用設(shè)備的租金等）和來源。 3.5 關(guān)鍵問題 逐項列出能夠影響整個項目成敗的關(guān)鍵問題、技術(shù)難點和風(fēng)險，指出這些問題對項目的影響。 4. 支持條件 說明為支持本項目的開發(fā)所需要的各種條件和設(shè)施。 4.1 計算機系統(tǒng)支持 逐項列出開發(fā)中和運行時所需的計算機系統(tǒng)支持，包括計算機、外圍設(shè)備、通訊設(shè)備、模擬器、編譯 （或 匯編）程序、操作系統(tǒng)、數(shù)據(jù)管理程序包、數(shù)據(jù)存儲能力和測試支持能力等，逐項給出有關(guān)到貨日期、 使用時間的要求。 4.2 需由用戶承擔(dān)的工作 逐項列出需要用戶承擔(dān)的工作和完成期限。包括需由用戶提供的條件及提供時間。 4.3 由外單位提供的條件 逐項列出需要外單位分合同承包者承擔(dān)的工作和完成的時間，包括需要由外單位提供的條件和提 供的時間。 5. 專題計劃要點 說明本項目開發(fā)中需制訂的各個專題計劃（如分合同計劃、開發(fā)人員培訓(xùn)計劃、測試計劃、安全保密 計劃、質(zhì)量保證計劃、配置管理計劃、用戶培訓(xùn)計劃、系統(tǒng)安裝計劃等）的要點。 （轉(zhuǎn)載自國家計算機標準和文件模板） 附錄3 軟件需求說明書 軟件需求說明書的編制是為了使用戶和軟件開發(fā)者雙方對該軟件的初始規(guī)定有一個共同的理解，使之成為整個開發(fā)工作的基礎(chǔ)。 軟件需求說明書的編制內(nèi)容要求如下： 1.引言 1.1 編寫目的 說明編寫這份軟件需求說明書的目的，指出預(yù)期的讀者。 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. 屬于本項目的其他已發(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 用戶的特點 列出本軟件的最終用戶的特點，充分說明操作人員、維護人員的教育水平和技術(shù)專長，以及本軟件的預(yù)期使甩頻度。這些是軟件設(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. 響應(yīng)時間； b. 更新處理時間； c. 數(shù)據(jù)的轉(zhuǎn)換和傳送時間； d. 解題時間等的要求。 3.2.3 靈活性 說明對該軟件的靈活性的要求，即當(dāng)需求發(fā)生某些變化時，該軟件對這些變化的適應(yīng)能力，如： a. 操作方式上的變化； b. 運行環(huán)境的變化； c. 同其他軟件的接口的變化； d. 精度和有效時限的變化； e. 計劃的變化或改進。 對于為了提供這些靈活性而進行的專門設(shè)計的部分應(yīng)該加以標明。 3.3 輸入輸出要求 解釋各輸入輸出數(shù)據(jù)類型，并逐項說明其媒體、格式、數(shù)值范圍、精度等。對軟件的數(shù)據(jù)輸出及必須標明的控制輸出量進行解釋并舉例，包括對硬拷貝報告（正常結(jié)果輸出、狀態(tài)輸出及異常輸出）以及圖形或顯示報告的描述。 3.4 數(shù)據(jù)管理能力要求 說明需要管理的文卷和記錄的個數(shù)、表和文卷的大小規(guī)模，要按可預(yù)見的增長對數(shù)據(jù)及其分量的存儲要求做出估算。 3.5 故障處理要求 列出可能的軟件、硬件故障以及對各項性能而言所產(chǎn)生的后果和對故障處理的要求。 3.6 其他專門要求 如用戶單位對安全保密的要求，對使用方便的要求，對可維護性、可補充性、易讀性、可靠性、運行環(huán)境可轉(zhuǎn)換性的特殊要求等。 4. 運行環(huán)境規(guī)定 4.1 設(shè)備 列出運行該軟件所需要的硬設(shè)備。說明其中的新型設(shè)備及其專門功能，包括： a. 處理器型號及內(nèi)在容量； b. 外存容量、聯(lián)機或脫機、媒體及其存儲格式，設(shè)備的型號及數(shù)量； c. 輸入及輸出設(shè)備的型號和數(shù)量，聯(lián)機或脫機； d. 數(shù)據(jù)通信設(shè)備的型號和數(shù)量； e. 功能鍵及其他專用硬件。 4.2 支持軟件 列出支持軟件，包括要用到的操作系統(tǒng)、編譯（或匯編）程序、測試支持軟件等。 4.3 接口 說明該軟件同其他軟件之間的接口、數(shù)據(jù)通信協(xié)議等。 4.4 控制 說明控制該軟件的運行的方法和控制信號，并說明這些控制信號的來源。 （轉(zhuǎn)載自國家計算機標準和文件模板） 附錄4 數(shù)據(jù)要求說明書 數(shù)據(jù)要求說明書的編制內(nèi)容要求如下： 1. 引言 1.1 編寫目的 說明編寫這份數(shù)據(jù)要求說明書的目的，指出預(yù)期的讀者。 1.2 背景 說明： a. 待開發(fā)的軟件系統(tǒng)的名稱； b. 列出本項目的任務(wù)提出者、開發(fā)者、用戶以及將運行該項軟件的計算站（中心）或計算機網(wǎng)絡(luò)系統(tǒng)。 1.3 定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 1.4 參考資料 列出用得著的參考資料，如： a.本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文； b. 屬于本項目的其他已發(fā)表的文件； c. 本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標準。 列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。 2. 數(shù)據(jù)的邏輯描述 對數(shù)據(jù)進行邏輯描述時可把數(shù)據(jù)分為動態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)。所謂靜態(tài)數(shù)據(jù)，指在運行過程中主要作 為參考的數(shù)據(jù)，它們在很長的一段時間內(nèi)不會變化，一般不隨運行而改變。所謂動態(tài)數(shù)據(jù)．包括所有在運 行中要發(fā)生變化的數(shù)據(jù)以及在運行中要輸入、輸出的數(shù)據(jù)。進行描述時應(yīng)把各數(shù)據(jù)元素邏輯地分成若干 組，列如函數(shù)、源數(shù)據(jù)或?qū)τ谄鋺?yīng)用更為恰當(dāng)?shù)倪壿嫹纸M。給出每一數(shù)據(jù)元的名稱（包括縮寫和代碼）、定 義（或物理意義）度量單位、值域、格式和類型等有關(guān)信息。 2.1 靜態(tài)數(shù)據(jù) 列出所有作為控制或參考用的靜態(tài)數(shù)據(jù)元素。 2.2 動態(tài)輸入數(shù)據(jù) 列出動態(tài)輸入數(shù)據(jù)元素（包括在常規(guī)運行中或聯(lián)機操作中要改變的數(shù)據(jù)）。 2.3 動態(tài)輸出數(shù)據(jù) 列出動態(tài)輸出數(shù)據(jù)元素（包括在常規(guī)運行中或聯(lián)機操作中要改變的數(shù)據(jù)）。 2.4 內(nèi)部生成數(shù)據(jù) 列出向用戶或開發(fā)單位中的維護調(diào)試人員提供的內(nèi)部生成數(shù)據(jù)。 2.5 數(shù)據(jù)約定 說明對數(shù)據(jù)要求的制約。逐條列出對進一步擴充或使用方面的考慮而提出的對數(shù)據(jù)要求的限制（容量、文卷、記錄和數(shù)據(jù)元的個數(shù)的最大值）。對于在設(shè)計和開發(fā)中確定是臨界性的限制更要明確指出。 3. 數(shù)據(jù)的采集 3.1 要求和范圍 按數(shù)據(jù)元的邏輯分組來說明數(shù)據(jù)采集的要求和范圍，指明數(shù)據(jù)的采集方法，說明數(shù)據(jù)采集工作的承擔(dān)者是用戶還是開發(fā)者。具體的內(nèi)容包括： a. 輸入數(shù)據(jù)的來源，例如是單個操作員、數(shù)據(jù)輸入站，專業(yè)的數(shù)據(jù)輸入公司或它們的一個分組； b. 數(shù)據(jù)輸入（指把數(shù)據(jù)輸入處理系統(tǒng)內(nèi)部）所用的媒體和硬設(shè)備。如果只有指定的輸入點的輸入才是合法的，則必須對此加以說明； c. 接受者說明輸出數(shù)據(jù)的接受者； d. 輸出數(shù)據(jù)的形式和設(shè)備列出輸出數(shù)據(jù)的形式和硬設(shè)備。無論接受者將接收到的數(shù)據(jù)是打印輸出，還是CRT上的一組字符、一幀圖形，或一聲警鈴，或向開關(guān)線圈提供的一個電脈沖，或常用介質(zhì)如磁盤、磁帶、穿孔卡片等，均應(yīng)具體說明； e. 數(shù)據(jù)值的范圍給出每一個數(shù)據(jù)元的合法值的范圍； f. 量綱給出數(shù)字的度量單位、增量的步長、零點的定標等。在數(shù)據(jù)是非數(shù)字量的情況下，要給出每一種合法值的形式和含意； g. 更新和處理的頻度給出預(yù)定的對輸入數(shù)據(jù)的更新和處理的頻度。如果數(shù)據(jù)的輸入是隨機的，應(yīng)給出更新處理的頻度的平均值，或變化情況的某種其他度量。 3.2 輸入的承擔(dān)者 說明預(yù)定的對數(shù)據(jù)輸入工作的承擔(dān)者。如果輸入數(shù)據(jù)同某一接口軟件有關(guān)，還應(yīng)說明該接口軟件的來源。 3.3 預(yù)處理 對數(shù)據(jù)的采集和預(yù)處理過程提出專門的規(guī)定，包括適合應(yīng)用的數(shù)據(jù)格式、預(yù)定的數(shù)據(jù)通信媒體和對輸入的時間要求等。對于需經(jīng)模擬轉(zhuǎn)換或數(shù)字轉(zhuǎn)換處理的數(shù)據(jù)量，要給出轉(zhuǎn)換方法和轉(zhuǎn)換因子等有關(guān)信息，以便軟件系統(tǒng)使用這些數(shù)據(jù)。 3.4 影響 說明這些數(shù)據(jù)要求對于設(shè)備、軟件、用戶、開發(fā)單位所可能產(chǎn)生的影響，例如要求用戶單位增設(shè)某個機構(gòu)等。 （轉(zhuǎn)載自國家計算機標準和文件模板） 附錄5 概要設(shè)計說明書 概要設(shè)計說明書的編制內(nèi)容要求如下： 1. 引言 1.1 編寫目的 說明編寫這份概要設(shè)計說明書的目的，指出預(yù)期的讀者。 1.2 背景 說明： a. 待開發(fā)的軟件系統(tǒng)的名稱； b. 列出本項目的任務(wù)提出者、開發(fā)者、用戶以及將運行該項軟件的計算站（中心）。 1.3 定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 1.4 參考資料 列出用得著的參考資料，如： a. 本項目的經(jīng)核準的計劃任務(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)元素的標識符和功能，分層次地給出各元素之間的控制與被控制關(guān)系。 2.5 功能要求與程序的關(guān)系 本條用一張如下的矩陣圖說明各項功能需求的實現(xiàn)同各塊程序的分配關(guān)系。 2.6 人工處理過程 說明在本軟件系統(tǒng)的工作過程中不得不包含的人工處理過程（如果有的話）。 2.7 尚未解決的問題 說明在概要設(shè)計過程中尚未解決而設(shè)計者認為在系統(tǒng)完成之前必須解決的各個問題。 3. 接口設(shè)計 3.1 用戶接口 說明將向用戶提供的命令和它們的語法結(jié)構(gòu)，以及軟件的回答信息。 3.2 外部接口 說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(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)所使用的每個數(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)的形式。 6. 系統(tǒng)出錯處理設(shè)計 6.1 出錯信息 用一覽表的方式說明每種可能的出錯或故障情況出現(xiàn)時，系統(tǒng)輸出信息的形式、含意及處理方法。 6.2 補救措施 說明故障出現(xiàn)后可能采取的變通措施，包括： a. 后備技術(shù)說明準備采用的后備技術(shù)，當(dāng)原始系統(tǒng)數(shù)據(jù)萬一丟失時啟用的副本的建立和啟動的技術(shù)，例如周期性地把磁盤信息記錄到磁帶上去就是對于磁盤媒體的一種后備技術(shù)； b. 降效技術(shù)說明準備采用的后備技術(shù)，使用另一個效率稍低的系統(tǒng)或方法來求得所需結(jié)果的某些部分，例如一個自動系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄； c. 恢復(fù)及再啟動技術(shù)說明將使用的恢復(fù)再啟動技術(shù)，使軟件從故障點恢復(fù)執(zhí)行或使軟件從頭開始重新運行的方法。 6.3 系統(tǒng)維護設(shè)計 說明為了系統(tǒng)維護的方便而在程序內(nèi)部設(shè)計中做出的安排，包括在程序中專門安排用于系統(tǒng)的檢查與維護的檢測點和專用模塊. （轉(zhuǎn)載自國家計算機標準和文件模板） 附錄6 詳細設(shè)計說明書 詳細設(shè)計說明書的編制內(nèi)容要求如下： 1. 引言 1.1 編寫目的 說明編寫這份詳細設(shè)計說明書的目的，指出預(yù)期的讀者。 1.2 背景 說明： a. 待開發(fā)的軟件系統(tǒng)的名稱； b. 列出本項目的任務(wù)提出者、開發(fā)者、用戶以及將運行該項軟件的計算中心。 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è)計說明 從本章開始，逐個地給出各個層次中的每個程序的設(shè)計考慮。以下給出的提綱是針對一般情況的。 對于一個具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內(nèi)容往往與它所隸屬的上一層 模塊的對應(yīng)條目的內(nèi)容相同，在這種情況下，只要簡單地說明這一點即可。 3.1 程序描述 給出對該程序的簡要描述，主要說明安排設(shè)計本程序的目的意義，并且，還要說明本程序的特點（如是常駐內(nèi)存還是非常駐？是否子程序？是可重用的還是不可重用的？有無覆蓋要求？是順序處理還是并發(fā)處理……等）。 3.2 功能 說明該程序應(yīng)具有的功能，可采用IPO圖（即輸入一處理一輸出圖）的形式。 3.3 性能 說明對該程序的全部性能要求，包括對精度、靈活性和時間特性的要求。 3.4 輸入項 給出對每一個輸入項的特性，包括名稱、標識、數(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ù)庫、數(shù)據(jù)文卷）。 3.9 存儲分配 根據(jù)需要，說明本程序的存儲分配。 3.10 注釋設(shè)計 說明準備在本程序中安排的注釋，如： a. 加在模塊首部的注釋； b. 加在各分枝點處的注釋； 對各變量的功能、范圍、缺省條件等所加的注釋； c. 對使用的邏輯所加的注釋等等。 3.11 限制條件 說明本程序運行中所受到的限制條件。 3.12 測試計劃 說明對本程序進行單體測試的計劃，包括對測試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進度安排、人員職責(zé)、設(shè)備條件驅(qū)動程序及樁模塊等的規(guī)定。 3.13 尚未解決的問題 說明在本程序的設(shè)計中尚未解決而設(shè)計者認為在軟件完成之前應(yīng)解決的問題。 4. 程序2（標識符）設(shè)計說明 用類似3的方式，說明第2個程序乃至第N個程序的設(shè)計考慮。 （轉(zhuǎn)載自國家計算機標準和文件模板） 附錄7 數(shù)據(jù)庫設(shè)計說明書 數(shù)據(jù)庫設(shè)計說明書的編制內(nèi)容要求如下： 1. 引言 1.1 編寫目的 說明編寫這份數(shù)據(jù)庫設(shè)計說明書的目的，指出預(yù)期的讀者。 1.2 背景 說明： a. 說明待開發(fā)的數(shù)據(jù)庫的名稱和使用此數(shù)據(jù)庫的軟件系統(tǒng)的名稱； b. 列出該軟件系統(tǒng)開發(fā)項目的任務(wù)提出者、用戶以及將安裝該軟件和這個數(shù)據(jù)庫的計算站（中心）。 1.3 定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 1.4 參考資料 列出有關(guān)的參考資料： a. 本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文； b. 屬于本項目的其他已發(fā)表的文件； c. 本文件中各處引用到的文件資料，包括所要用到的軟件開發(fā)標準。 列出這些文件的標題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件的來源。 2. 外部設(shè)計 2.1 標識符和狀態(tài) 聯(lián)系用途，詳細說明用于唯一地標識該數(shù)據(jù)庫的代碼、名稱或標識符，附加的描述性信息亦要給出。如果該數(shù)據(jù)庫屬于尚在實驗中、尚在測試中或是暫時使用的，則要說明這一特點及其有效時間范圍。 2.2 使用它的程序 列出將要使用或訪問此數(shù)據(jù)庫的所有應(yīng)用程序，對于這些應(yīng)用程序的每一個，給出它的名稱和版本號。 2.3 約定 陳述一個程序員或一個系統(tǒng)分析員為了能使用此數(shù)據(jù)庫而需要了解的建立標號、標識的約定，例如 用于標識數(shù)據(jù)庫的不同版本的約定和用于標識庫內(nèi)各個文卷、、記錄、數(shù)據(jù)項的命名約定等。 2.4 專門指導(dǎo) 向準備從事此數(shù)據(jù)庫的生成、從事此數(shù)據(jù)庫的測試、維護人員提供專門的指導(dǎo)，例如將被送入數(shù)據(jù) 庫的數(shù)據(jù)的格式和標準、送入數(shù)據(jù)庫的操作規(guī)程和步驟，用于產(chǎn)生、修改、更新或使用這些數(shù)據(jù)文卷的操 作指導(dǎo)。 如果這些指導(dǎo)的內(nèi)容篇幅很長，列出可參閱的文件資料的名稱和章條。 2.5 支持軟件 簡單介紹同此數(shù)據(jù)庫直接有關(guān)的支持軟件，如數(shù)據(jù)庫管理系統(tǒng)、存儲定位程序和用于裝入、生成、修改、更新數(shù)據(jù)庫的程序等。說明這些軟件的名稱、版本號和主要功能特性，如所用數(shù)據(jù)模型的類型、允許 的數(shù)據(jù)容量等。列出這些支持軟件的技術(shù)文件的標題、編號及來源。 3. 結(jié)構(gòu)設(shè)計 3.1 概念結(jié)構(gòu)設(shè)計 說明本數(shù)據(jù)庫將反映的現(xiàn)實世界中的實體、屬性和它們之間的關(guān)系等的原始數(shù)據(jù)形式，包括各數(shù)據(jù)項、記錄、系、文卷的標識符、定義、類型、度量單位和值域，建立本數(shù)據(jù)庫的每一幅用戶視圖。 3.2 邏輯結(jié)構(gòu)設(shè)計 說明把上述原始數(shù)據(jù)進行分解、合并后重新組織起來的數(shù)據(jù)庫全局邏輯結(jié)構(gòu)，包括所確定的關(guān)鍵字和屬性、重新確定的記錄結(jié)構(gòu)和文卷結(jié)構(gòu)、所建立的各個文卷之間的相互關(guān)系，形成本數(shù)據(jù)庫的數(shù)據(jù)庫管理員視圖。 3.3 物理結(jié)構(gòu)設(shè)計 建立系統(tǒng)程序員視圖，包括： a. 數(shù)據(jù)在內(nèi)存中的安排，包括對索引區(qū)、緩沖區(qū)的設(shè)計； b. 所使用的外存設(shè)備及外存空間的組織，包括索引區(qū)、數(shù)據(jù)塊的組織與劃分； c. 訪問數(shù)據(jù)的方式方法。 4. 運用設(shè)計 4.1 數(shù)據(jù)字典設(shè)計 對數(shù)據(jù)庫設(shè)計中涉及到的各種項目，如數(shù)據(jù)項、記錄、系、文卷、模式、子模式等一般要建立起數(shù)據(jù)字典，以說明它們的標識符、同義名及有關(guān)信息。在本節(jié)中要說明對此數(shù)據(jù)字典設(shè)計的基本考慮。 4.2 安全保密設(shè)計 說明在數(shù)據(jù)庫的設(shè)計中，將如何通過區(qū)分不同的訪問者、不同的訪問類型和不同的數(shù)據(jù)對象，進行分別對待而獲得的數(shù)據(jù)庫安全保密的設(shè)計考慮?！? （轉(zhuǎn)載自國家計算機標準和文件模板） 附錄8 用戶手冊 用戶手冊的編制內(nèi)容要求如下： 1. 引言 1.1 編寫目的 說明編寫這份用戶手冊的目的，指出預(yù)期的讀者。 1.2 背景 說明： a. 這份用戶手冊所描述的軟件系統(tǒng)的名稱； b. 該軟件項目的任務(wù)提出者、開發(fā)者、用戶（或首批用戶）及安裝此軟件的計算中心。 1.3 定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 1.4 參考資料 列出有用的參考資料，如： a. 本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文； b. 屬于本項目的其他已發(fā)表的文件； c. 本文件中各處引用到的文件資料，包括所要用到的軟件開發(fā)標準。 列出這些文件的標題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件的來源。 2. 用途 2.1 功能 結(jié)合本軟件的開發(fā)目的逐項地說明本軟件所具有各項功能以及它們的極限范圍。 2.2 性能 2.2.1 精度 逐項說明對各項輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達到的精度，包括傳輸中的精度要求。 2.2.2 時間特性 定量地說明本軟件的時間特性，如響應(yīng)時間，更新處理時間，數(shù)據(jù)傳輸、轉(zhuǎn)換時間，計算時間等。 2.2.3 靈活性 說明本軟件所具有的靈活性，即當(dāng)用戶需求（如對操作方式、運行環(huán)境、結(jié)果精度、時間特性等的要求）有某些變化時，本軟件的適應(yīng)能力。 2.3 安全保密 說明本軟件在安全、保密方面的設(shè)計考慮和實際達到的能力。 3. 運行環(huán)境 3.1 硬設(shè)備 列出為運行本軟件所要求的硬設(shè)備的最小配置，如： a. 處理機的型號、內(nèi)存容量； b. 所要求的外存儲器、媒體、記錄格式、設(shè)備的型號和臺數(shù)、聯(lián)機／脫機； c. I／O設(shè)備（聯(lián)機／脫機？）； d. 數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號、臺數(shù)。 3.2 支持軟件 說明為運行本軟件所需要的支持軟件，如： a. 操作系統(tǒng)的名稱、版本號； b. 程序語言的編譯／匯編系統(tǒng)的名稱和版本號； c. 數(shù)據(jù)庫管理系統(tǒng)的名稱和版本號； d. 其他支持軟件。 3.3 數(shù)據(jù)結(jié)構(gòu) 列出為支持本軟件的運行所需要的數(shù)據(jù)庫或數(shù)據(jù)文卷。 4. 使用過程 在本章，首先用圖表的形式說明軟件的功能同系統(tǒng)的輸入源機構(gòu)、輸出接收機構(gòu)之間的關(guān)系。 4.1 安裝與初始化 一步一步地說明為使用本軟件而需進行的安裝與初始化過程，包括程序的存儲形式、安裝與初始化過程中的全部操作命令、系統(tǒng)對這些命令的反應(yīng)與答復(fù)。表征安裝工作完成的測試實例等。如果有的話，還應(yīng)說明安裝過程中所需用到的專用軟件。 4.2 輸入 規(guī)定輸入數(shù)據(jù)和參量的準備要求。 4.2.1 輸入數(shù)據(jù)的現(xiàn)實背景 說明輸入數(shù)據(jù)的現(xiàn)實背景，主要是： a. 情況——例如人員變動、庫存缺貨； b. 情況出現(xiàn)的頻度——例如是周期性的、隨機的、一項操作狀態(tài)的函數(shù)； c. 情況來源——例如人事部門、倉庫管理部門； d. 輸入媒體——例如鍵盤、穿孔卡片、磁帶； e. 限制——出于安全、保密考慮而對訪問這些輸入數(shù)據(jù)所加的限制； f. 質(zhì)量管理——例如對輸入數(shù)據(jù)合理性的檢驗以及當(dāng)輸入數(shù)據(jù)有錯誤時應(yīng)采取的措施，如建立出錯情況的記錄等； g. 支配——例如如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。 4.2.2 輸入格式 說明對初始輸入數(shù)據(jù)和參量的格式要求，包括語法規(guī)則和有關(guān)約定，如： a. 長度——例如字符數(shù)／行，字符數(shù)／項； b. 格式基準——例如以左面的邊沿為基準； c. 標號——例如標記或標識符； d. 順序——例如各個數(shù)據(jù)項的次序及位置； e. 標點——例如用來表示行、數(shù)據(jù)組等的開始或結(jié)束而使用的空格、斜線、星號、字符組等。 f. 詞匯表——給出允許使用的字符組合的列表，禁止使用＊的字符組合的列表等； g. 省略和重復(fù)——給出用來表示輸人元素可省略或重復(fù)的表示方式； h. 控制——給出用來表示輸入開始或結(jié)束的控制信息。 4.2.3 輸入舉例 為每個完整的輸入形式提供樣本，包括： a. 控制或首部——例如用來表示輸入的種類和類型的信息，標識符輸入日期，正文起點和對所用編碼的規(guī)定； b. 主體——輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分； c. 尾部——用來表示輸入結(jié)束的控制信息，累計字符總數(shù)等； d. 省略——指出哪些輸入數(shù)據(jù)是可省略的； e. 重復(fù)——指出哪些輸入數(shù)據(jù)是重復(fù)的。 4.3 輸出 對每項輸出作出說明。 4.3.1 輸入數(shù)據(jù)的現(xiàn)實背景 說明輸出數(shù)據(jù)的現(xiàn)實背景，主要是： a. 使用——這些輸出數(shù)據(jù)是給誰的，用來干什么； b. 使用頻度——例如每周的、定期的或備查閱的； c. 媒體——打印、CRT顯示、磁帶、卡片、磁盤； d. 質(zhì)量管理——例如關(guān)于合理性檢驗、出錯糾正的規(guī)定； e. 支配——例如如何確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受者等。 4.3.2 輸出格式 給出對每一類輸出信息的解釋，主要是： a. 首部——如輸出數(shù)據(jù)的標識符，輸出日期和輸出編號； b. 主體——輸出信息的主體，包括分欄標題； c. 尾部——包括累計總數(shù)，結(jié)束標記。 4.3.3 輸出舉例 為每種輸出類型提供例子。對例子中的每一項，說明： a. 定義——每項輸出信息的意義和用途； b. 來源——是從特定的輸入中抽出、從數(shù)據(jù)庫文卷中取出、或從軟件的計算過程中得到； c. 特性——輸出的值域、計量單位、在什么情況下可缺省等。 4.4 文卷查詢 這一條的編寫針對具有查詢能力的軟件，內(nèi)容包括：同數(shù)據(jù)庫查詢有關(guān)的初始化、準備、及處理所需 要的詳細規(guī)定，說明查詢的能力、方式，所使用的命令和所要求的控制規(guī)定。 4.5 出錯處理和恢復(fù) 列出由軟件產(chǎn)生的出錯編碼或條件以及應(yīng)由用戶承擔(dān)的修改糾正工作。指出為了確保再啟動和恢復(fù)的能力，用戶必須遵循的處理過程。 4.6 終端操作 當(dāng)軟件是在多終端系統(tǒng)上工作時，應(yīng)編寫本條，以說明終端的配置安排、連接步釋、數(shù)據(jù)和參數(shù)輸入 步驟以及控制規(guī)定．說明通過終端操作進行查詢、檢索、修改數(shù)據(jù)文卷的能力、語言、過程以及輔助性程 序等。 （轉(zhuǎn)載自標準化信息網(wǎng)） 附錄9 操作手冊 操作手冊的編制內(nèi)容要求如下： 1. 引言 1.1 編寫目的 說明編寫這份操作手冊的目的，指出預(yù)期的讀者。 1.2 背景 說明： a. 這份操作手冊所描述的軟件系統(tǒng)的名稱； b. 該軟件項目的任務(wù)提出者、開發(fā)者、用戶（或首批用戶）及安裝該軟件的計算中心。 1.3 定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 1.4 參考資料 列出有用的參考資料，如： a. 本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文； b. 屬于本項目的其他已發(fā)表的文件； c. 本文件中各處引用到的文件資料，包括所要用到的軟件開發(fā)標準。 列出這些文件的標題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件的來源。 2. 軟件征述 2.1 軟件的結(jié)構(gòu) 結(jié)合軟件系統(tǒng)所具有的功能包括輸入、處理和輸出提供該軟件的總體結(jié)構(gòu)圖表。 2.2 程序表 列出本系統(tǒng)內(nèi)每個程序的標識符、編號和助記名。 2.3 文卷表 列出將由本系統(tǒng)引用、建立或更新的每個永久性文卷，說明它們各自的標識符、編號、助記名、存儲 媒體和存儲要求。 3. 安裝與初始化 一步一步地說明為使用本軟件而需要進行的安裝與初始化過程，包括程序的存載形式，安裝與初始 化過程中的全部操作命令，系統(tǒng)對這些命令的反應(yīng)與答復(fù)，表征安裝工作完成的測試實例等。如果有的 話，還應(yīng)說明安裝過程中所需用到的專用軟件。 4. 運行說明 所謂一個運行是指提供一個啟動控制信息后，直到計算機系統(tǒng)等待另一個啟動控制信息時為止的 計算機系統(tǒng)執(zhí)行的全部過程。 4.1 運行表 列出每種可能的運行，摘要說明每個運行的目的，指出每個運行各自所執(zhí)行的程序。 4.2 運行步驟 說明從一個運行轉(zhuǎn)向另一個運行以完成整個系統(tǒng)運行的步驟。 4.3 運行1（標識符）說明 把運行1的有關(guān)信息，以對操作人員為最方便最有用的形式加以說明。 4.3.1 運行控制 列出為本運行所需要"的運行流向控制的說明。 4.3.2 操作信息 給出為操作中心的操作人員和管理人員所需要的信息，如： a. 運行目的； b. 操作要求； c. 啟動方法，如應(yīng)請啟動（由所遇到的請求信息啟動）、預(yù)定時間啟動、……等； d. 預(yù)計的運行時間和解題時間；操作命令； f. 與運行有聯(lián)系的其他事項。 4.3.3 輸入－輸出文卷 提供被本運行建立、更新或訪問的數(shù)據(jù)文卷的有關(guān)信息，如： a. 文卷的標識符或標號； b. 記錄媒體； c. 存留的目錄表； d. 文卷的支配如確定保留或廢棄的準則、是否要分配給其他接受者、占用硬設(shè)備的優(yōu)先級以及保密控制等有關(guān)規(guī)定。 4.3.4 輸出文段 提供本軟件輸出的每一個用于提示、說明、或應(yīng)答的文段（包括“菜單”）的有關(guān)信息，如： a. 文段的標識符； b. 輸出媒體（屏幕顯示、打印、……）； c. 文字容量； d. 分發(fā)對象； e. 保密要求。 4.3.5 輸出文段的復(fù)制 對由計算機產(chǎn)生，而后需用其他方法復(fù)制的那些文段提供有關(guān)信息，如： a. 文段的標識符； b. 復(fù)制的技術(shù)手段； c. 紙張或其他媒體的規(guī)格； d. 裝訂要求； e. 分發(fā)對象； f. 復(fù)制人數(shù)。 4.3.6 恢復(fù)過程 說明本運行故障后的恢復(fù)過程。 4.4 運行2（標識符）說明 用與本手冊4.3條相類似的方式介紹另一個運行的有關(guān)信息。 5. 非常規(guī)過程 提供有關(guān)應(yīng)急操作或非常規(guī)操作的必要信息，如出錯處理操作、向后備系統(tǒng)的切換操作以及其他必 須向程序維護人員交待的事項和步驟。 6. 遠程操作 如果本軟件能夠通過遠程終端控制運行，則在本章說明通過遠程終端運行本軟件的操作過程。 （轉(zhuǎn)載自標準化信息網(wǎng)） 附錄10 模塊開發(fā)卷宗 模塊開發(fā)卷宗的編制內(nèi)容要求如下： 1. 標題 軟件系統(tǒng)名稱和標識符 模塊名稱和標識符（如果本卷宗包含多于一個的模塊，則用這組模塊的功能標識代替模塊名） 程序編制員簽名 卷宗的修改文本序號 修改完成日期 卷宗序號（說明本卷宗在整個卷宗中的序號） 編排日期（說明整個卷宗最近的一次編排日期） 2. 模塊開發(fā)情況表 3. 功能說明 扼要說明本模塊（或本組模塊）的功能，主要是輸入、要求的處理、輸出。可以從系統(tǒng)設(shè)計說明書中摘錄。同時列出在軟件需求說明書中對這些功能的說明的章、條、款。 4. 設(shè)計說明 說明本模塊（或本組模塊）的設(shè)計考慮，包括： a. 在系統(tǒng)設(shè)計說明書中有關(guān)對本模塊（或本組模塊）設(shè)計考慮的敘述，包括本模塊在軟件系統(tǒng)中所處的層次，它同其他模塊的接口； b. 在程序設(shè)計說明書中有關(guān)對本模塊（或本組模塊）的設(shè)計考慮，包括本模塊的算法、處理流程、牽涉到的數(shù)據(jù)文卷設(shè)計限制、驅(qū)動方式和出錯信息等； c. 在編制目前已通過全部測試的源代碼時實際使用的設(shè)計考慮。 5. 原代碼清單 要給出所產(chǎn)生的本模塊（或本組模塊）的第一份無語法錯的源代碼清單以及已通過全部測試的當(dāng)前有效的源代碼清單。 6. 測試說明 說明直接要經(jīng)過本模塊（或本組模塊）的每一項測試，包括這些測試各自的標識符和編號、進行這些測試的目的、所用的配置和輸入、預(yù)期的輸出及實際的輸出。 7. 復(fù)審的結(jié)論 把實際測試的結(jié)果，同軟件需求說明書、系統(tǒng)設(shè)計說明書、程序設(shè)計說明書中規(guī)定的要求進行比較和給出結(jié)論。 （轉(zhuǎn)載自國家計算機標準和文件模板） 附錄11 測試計劃 測試計劃的編制內(nèi)容要求如下： 1. 引言 1.1 編寫目的 本測試計劃的具體編寫目的，指出預(yù)期的讀者范圍。 1.2 背景 說明： a. 測試計劃所從屬的軟件系統(tǒng)的名稱； b. 該開發(fā)項目的歷史，列出用戶和執(zhí)行此項目測試的計算中心，說明在開始執(zhí)行本測試計劃之前必須完成的各項工作。 1.3 定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 1.4 參考資料 列出要用到的參考資料，如： a. 本項目的經(jīng)核準的計劃任務(wù)書或合同、上級機關(guān)的批文； b. 屬于本項目的其他已發(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)境。培訓(xùn)、準備輸入數(shù)據(jù)等）。 2.3.2 條件 陳述本項測試工作對資源的要求，包括： a. 設(shè)備所用到的設(shè)備類型、數(shù)量和預(yù)定使用時間； b. 軟件列出將被用來支持本項測試過程而本身又并不是被測軟件的組成部分的軟件，如測試驅(qū)動程序、測試監(jiān)控程序、仿真程序、樁模塊等等； c. 人員列出在測試工作期間預(yù)期可由用戶和開發(fā)任務(wù)組提供的工作人員的人數(shù)。技術(shù)水平及有關(guān)的預(yù)備知識，包括一些特殊要求，如倒班操作和數(shù)據(jù)鍵入人員。 2.3.3 測試資料 列出本項測試所需的資料，如： a. 有關(guān)本項任務(wù)的文件； b. 被測試程序及其所在的媒體； c. 測試的輸入和輸出舉例； d. 有關(guān)控制此項測試的方法、過程的圖表。 2.3.4 測試培訓(xùn) 說明或引用資料說明為被測軟件的使用提供培訓(xùn)的計劃。規(guī)定培訓(xùn)的內(nèi)容、受訓(xùn)的人員及從事培訓(xùn)的工作人員。 2.4 測試2（標識符） 用與本測試計劃2.3條相類似的方式，說明用于另一項及其后