軟件設(shè)計(jì)文檔國家標(biāo)準(zhǔn)

1、http:/adyhpq.blog. 163. com/blog/static/386670020100115352958/模塊開發(fā)卷宗（gb856788）1標(biāo)題軟件系統(tǒng)名稱和標(biāo)識(shí)符模塊名稱和標(biāo)識(shí)符（如果木卷宗包含多于一個(gè)的模塊，則用這組模塊的功能 標(biāo)識(shí)代替模塊名）程序編制員簽名卷宗的修改文木序號(hào)修改完成ri期卷宗序號(hào)（說明本卷宗在整個(gè)卷宗中的序號(hào)）編排fi期（說明整個(gè)卷宗最近的一次編排fi期）2模塊開發(fā)情況表3功能說明扼要說明本模塊（或本組模塊）的功能，主要是輸入、要求的處理、輸岀。 可以從系統(tǒng)設(shè)計(jì)說明書小摘錄。同時(shí)列出在軟件需求說明書屮對(duì)這些功能的說明 的章、條、款。4設(shè)計(jì)說明說明木模塊（

2、或木組模塊）的設(shè)計(jì)考慮，包括：a. 在系統(tǒng)設(shè)計(jì)說明書中有關(guān)對(duì)本模塊（或本組模塊）設(shè)計(jì)考慮的敘述， 包括本模塊在軟件系統(tǒng)小所處的層次，它同其他模塊的接口；b. 在程序設(shè)計(jì)說明書屮冇關(guān)對(duì)本模塊（或本組模塊）的設(shè)計(jì)考慮，包括 本模塊的算法、處理流程、牽涉到的數(shù)據(jù)文卷設(shè)計(jì)限制、驅(qū)動(dòng)方式和出錯(cuò)信息等;c. 在編制口前已通過全部測(cè)試的源代碼吋實(shí)際使用的設(shè)計(jì)考慮。5原代碼清單要給出所產(chǎn)生的本模塊（或木組模塊）的第一份無語法錯(cuò)的源代碼清單以及 已通過全部測(cè)試的當(dāng)前冇效的源代碼清單。6測(cè)試說明說明直接要經(jīng)過木模塊（或木組模塊）的每一項(xiàng)測(cè)試，包括這些測(cè)試各自的 標(biāo)識(shí)符和編號(hào)、進(jìn)行這些測(cè)試的目的、所用的配置和輸入、

3、預(yù)期的輸出及實(shí)際的 輸出。7復(fù)審的結(jié)論把實(shí)際測(cè)試的結(jié)果，同軟件需求說明書、系統(tǒng)設(shè)計(jì)說明書、程序設(shè)計(jì)說明書 中規(guī)定的要求進(jìn)行比較和給岀結(jié)論。軟件需求說明書的編寫提示（gb856t88）1引言1.1編寫目的說明編寫這份軟件需求說明書的口的，指出預(yù)期的讀者。12背景說明：a. 待開發(fā)的軟件系統(tǒng)的名稱；b. 木項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)該軟件的計(jì)算中心或計(jì)算 機(jī)網(wǎng)絡(luò)；0.該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來往關(guān)系。13定義列岀本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1. 4參考資料列出用得著的參考資料，女山a. 本項(xiàng)r的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b. 屬

4、于木項(xiàng)r的其他已發(fā)表的文件;c.本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列 出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和岀版單位，說明能夠得到這些文 件資料的來源。2任務(wù)概述2. 1目標(biāo)敘述該項(xiàng)軟件開發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其他應(yīng)向讀者說明的有 關(guān)該軟件開發(fā)的背景材料。解釋被開發(fā)軟件與其他冇關(guān)軟件z間的關(guān)系。如果 本軟件產(chǎn)品是一項(xiàng)獨(dú)立的軟件，而且全部內(nèi)容口含，則說明這一點(diǎn)。如果所定義 的產(chǎn)品是一個(gè)更大的系統(tǒng)的一個(gè)組成部分，則應(yīng)說明木產(chǎn)品與該系統(tǒng)屮其他各 組成部分之間的關(guān)系，為此可使用i張方框圖來說明該系統(tǒng)的組成和本產(chǎn)品同其 他齊部分的聯(lián)系和接口。丨22用戶的特點(diǎn)列出本軟

5、件的最終用戶的特點(diǎn)，充分說明操作人員、維護(hù)人員的教育水平和 技術(shù)專長，以及木軟件的預(yù)期使甩頻度。這些是軟件設(shè)計(jì)工作的重要約朿2. 3假定和約束列出進(jìn)行本軟件開發(fā)工作的假定和約束，例如經(jīng)費(fèi)限制、開發(fā)期限等。3需求規(guī)定3. 1對(duì)功能的規(guī)定用列表的方式（例如ipo表即輸入、處理、輸出表的形式），逐項(xiàng)定量和定 性地?cái)⑹鰧?duì)軟件所提岀的功能要求，說明輸入什么量、經(jīng)怎樣的處理、得到什么 輸出，說明軟件應(yīng)支持的終端數(shù)和應(yīng)支持的并行操作的用戶數(shù)。3. 2對(duì)性能的規(guī)定3. 2. 1精度說明對(duì)該軟件的輸入、輸岀數(shù)據(jù)精度的要求，可能包括傳輸過程中的精度。3.2.2時(shí)間特性要求說明對(duì)于該軟件的時(shí)間特性要求，如對(duì)：a.

6、響應(yīng)時(shí)間；b. 更新處理時(shí)間;c.數(shù)據(jù)的轉(zhuǎn)換和傳送時(shí)間；d. 解題時(shí)間；等的要求。3. 2. 3靈活性說明對(duì)該軟件的靈活性的要求，即當(dāng)需求發(fā)生某些變化吋，該軟件對(duì)這些變 化的適應(yīng)能力，如：a. 操作方式上的變化；b. 運(yùn)行環(huán)境的變化；c. 同其他軟件的接口的變化；d. 精度和有效吋限的變化；e. 計(jì)劃的變化或改進(jìn)。對(duì)于為了提供這些靈活性而進(jìn)行的專門設(shè)計(jì)的部分應(yīng)該加以標(biāo)明。33輸人輸岀要求解釋各輸入輸出數(shù)據(jù)類型，并逐項(xiàng)說明其媒體、格式、數(shù)值范圍、精度等。 對(duì)軟件的數(shù)據(jù)輸出及必須標(biāo)明的控制輸出量進(jìn)行解釋并舉例，包括對(duì)硬拷貝報(bào)告 （正常結(jié)果輸出、狀態(tài)輸出及異常輸出）以及圖形或顯示報(bào)告的描述。3. 4

7、數(shù)據(jù)管理能力要求說明需要管理的文卷和記錄的個(gè)數(shù)、表和文卷的大小規(guī)模，要按可預(yù)見的增 長對(duì)數(shù)據(jù)及其分量的存儲(chǔ)要求作出估算。3. 5故障處理要求列出可能的軟件、硬件故障以及對(duì)各項(xiàng)性能而言所產(chǎn)生的后果和對(duì)故障處理 的要求。3.6其他專門要求如用戶單位對(duì)安全保密的要求，對(duì)使用方便的要求，對(duì)可維護(hù)性、可補(bǔ)充性、 易讀性、可靠性、運(yùn)行環(huán)境可轉(zhuǎn)換性的特殊要求等。4運(yùn)行環(huán)境規(guī)定4. 1設(shè)備列出運(yùn)行該軟件所需要的硬設(shè)備。說明其中的新型設(shè)備及其專門功能,包括:a. 處理器型號(hào)及內(nèi)存容量；b. 外存容量、聯(lián)機(jī)或脫機(jī)、媒體及其存儲(chǔ)格式，設(shè)備的型號(hào)及數(shù)量；c. 輸入及輸出設(shè)備的型號(hào)和數(shù)量，聯(lián)機(jī)或脫機(jī)；d. 數(shù)據(jù)通信設(shè)備

8、的型號(hào)和數(shù)量；c. 功能鍵及其他專用硬件4. 2支持軟件列出支持軟件，包扌舌要用到的操作系統(tǒng)、編譯（或匯編）程序、測(cè)試支持軟 件等。4.3 接口說明該軟件同其他軟件z間的接11、數(shù)據(jù)通信協(xié)議等。4. 4控制說明控制該軟件的運(yùn)行的方法和控制信號(hào)，并說明這些控制信號(hào)的來源。數(shù)據(jù)庫設(shè)計(jì)說明書（gb856788）1引言1. 1編寫目的說明編寫這份數(shù)據(jù)庫設(shè)計(jì)說明書的目的，指出預(yù)期的讀者。1.2背景說明：a. 說明待開發(fā)的數(shù)據(jù)庫的名稱和使用此數(shù)據(jù)庫的軟件系統(tǒng)的名稱；b. 列出該軟件系統(tǒng)開發(fā)項(xiàng)目的任務(wù)捉出者、用戶以及將安裝該軟件和這 個(gè)數(shù)據(jù)庫的計(jì)算站（中心）。1.3定義列出本文件中用到的專門術(shù)語的定義、外文

9、首字母組詞的原詞組。14參考資料列出有關(guān)的參考資料：a. 木項(xiàng)口的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)批文；b. 屬于本項(xiàng)目的其他已發(fā)表的文件；c. 本文件中齊處引用到的文件資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和岀版單位，說明能夠取得這些 文件的來源。2外部設(shè)計(jì)2. 1標(biāo)識(shí)符和狀態(tài)聯(lián)系用途，詳細(xì)說明用于唯一地標(biāo)識(shí)該數(shù)據(jù)庫的代碼、名稱或標(biāo)識(shí)符，附加 的描述性信息亦要給出。如果該數(shù)據(jù)庫屈于尚在實(shí)驗(yàn)屮、尚在測(cè)試屮或是暫時(shí)使 用的，則要說明這一特點(diǎn)及其有效時(shí)間范圍。2. 2使用它的程序列出將要使用或訪問此數(shù)據(jù)庫的所冇應(yīng)用程序，對(duì)于這些應(yīng)用程序的每一 個(gè)，給出它的名稱和

10、版木號(hào)。2.3約定陳述一個(gè)程序員或一個(gè)系統(tǒng)分析員為了能使用此數(shù)據(jù)庫而需要了解的建立 標(biāo)號(hào)、標(biāo)識(shí)的約定，例如用于標(biāo)識(shí)數(shù)據(jù)庫的不同版本的約定和用于標(biāo)識(shí)庫內(nèi)各個(gè) 文卷、記錄、數(shù)據(jù)項(xiàng)的命名約定等。2.4專門指導(dǎo)向準(zhǔn)備從事此數(shù)據(jù)庫的生成、從事此數(shù)據(jù)庫的測(cè)試、維護(hù)人員捉供專門的指 導(dǎo)，例如將被送入數(shù)據(jù)庫的數(shù)據(jù)的格式和標(biāo)準(zhǔn)、送入數(shù)據(jù)庫的操作規(guī)程和步驟， 用于產(chǎn)生、修改、更新或使用這些數(shù)據(jù)文卷的操作指導(dǎo)。如果這些指導(dǎo)的內(nèi)容篇 幅很長，列出可參閱的文件資料的名稱和章條。2. 5支持軟件簡(jiǎn)單介紹同此數(shù)據(jù)庫直接冇關(guān)的支持軟件，如數(shù)據(jù)庫管理系統(tǒng)、存儲(chǔ)定位程 序和用于裝入、生成、修改、更新數(shù)據(jù)庫的程序等。說明這些軟件的

11、名稱、版 木號(hào)和主要功能特性，如所用數(shù)據(jù)模型的類型、允許的數(shù)據(jù)容量等。列出這些 支持軟件的技術(shù)文件的標(biāo)題、編號(hào)及來源。3結(jié)構(gòu)設(shè)計(jì)3. 1概念結(jié)構(gòu)設(shè)計(jì)說明本數(shù)據(jù)庫將反映的現(xiàn)實(shí)世界中的實(shí)體、屬性和它們之間的關(guān)系等的原始 數(shù)據(jù)形式，包括齊數(shù)據(jù)項(xiàng)、記錄、系、文卷的標(biāo)識(shí)符、定義、類型、度量單位和 值域，建立本數(shù)據(jù)庫的每一幅用戶視圖。3. 2邏輯結(jié)構(gòu)設(shè)計(jì)說明把上述原始數(shù)據(jù)進(jìn)行分解、合并后重新組織起來的數(shù)據(jù)庫全局邏輯結(jié) 構(gòu)，包括所確定的關(guān)鍵字和屬性、重新確定的記錄結(jié)構(gòu)和文卷結(jié)構(gòu)、所建立的各 個(gè)文卷z間的相互關(guān)系，形成本數(shù)據(jù)庫的數(shù)據(jù)庫管理員視圖。3. 3物理結(jié)構(gòu)設(shè)計(jì)建立系統(tǒng)程序員視圖，包扌舌：a. 數(shù)據(jù)在內(nèi)存

12、屮的安排，包括對(duì)索引區(qū)、緩沖區(qū)的設(shè)計(jì)；b. 所使用的外存設(shè)備及外存空間的組織，包括索引區(qū)、數(shù)據(jù)塊的組織與 劃分；c. 訪問數(shù)據(jù)的方式方法。4運(yùn)用設(shè)計(jì)4.1數(shù)據(jù)字典設(shè)計(jì)對(duì)數(shù)據(jù)庫設(shè)計(jì)中涉及到的各種項(xiàng)目，如數(shù)據(jù)項(xiàng)、記錄、系、文卷、模式、子 模式等一般要建立起數(shù)據(jù)字典，以說明它們的標(biāo)識(shí)符、同義名及有關(guān)信息。在本 節(jié)屮要說明對(duì)此數(shù)據(jù)字典設(shè)計(jì)的基本考慮。4. 2安全保密設(shè)計(jì)說明在數(shù)據(jù)庫的設(shè)計(jì)屮，將如何通過區(qū)分不同的訪問者、不同的訪問類型和 不同的數(shù)據(jù)對(duì)象，進(jìn)行分別對(duì)待而獲得的數(shù)據(jù)庫安全保密的設(shè)計(jì)考慮。數(shù)據(jù)要求說明書(gb856t88)1引言11編寫目的說明編寫這份數(shù)據(jù)要求說明卩的目的，指岀預(yù)期的讀者。1.

13、 2背景說明：a. 待開發(fā)軟件系統(tǒng)的名稱；b. 列出本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶以及將運(yùn)行該項(xiàng)軟件的計(jì)算站（中 心）或計(jì)算機(jī)網(wǎng)絡(luò)系統(tǒng)。1.3定義列岀木文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出有關(guān)的參考資料，女口：a. 本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)帖或合同，上級(jí)機(jī)關(guān)的批文；b. 屬于本項(xiàng)目的其他已發(fā)表文件；c. 木文件屮各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出 這些文件的標(biāo)題、文件編號(hào)、發(fā)表fi期和出版單位。說明能夠得到這些文件資料 的來源。2數(shù)據(jù)的邏輯描述對(duì)數(shù)據(jù)進(jìn)行邏輯描述時(shí)可把數(shù)據(jù)分為動(dòng)態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)。所謂靜態(tài)數(shù)據(jù)， 指在運(yùn)行過程屮主要作為參考的

14、數(shù)據(jù)，它們?cè)诤荛L的一段吋間內(nèi)不會(huì)變化，一 般不隨運(yùn)行而改變。所謂動(dòng)態(tài)數(shù)據(jù)，包括所冇在運(yùn)行中要發(fā)生變化的數(shù)據(jù)以及在 運(yùn)行中要輸入、輸出的數(shù)據(jù)。進(jìn) 行描述時(shí)應(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動(dòng)態(tài)輸人數(shù)據(jù)列出動(dòng)態(tài)輸入數(shù)據(jù)元素（包描在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù)）。23動(dòng)態(tài)輸出數(shù)據(jù)列岀動(dòng)態(tài)輸岀數(shù)據(jù)元索（包括在常規(guī)運(yùn)行屮或聯(lián)機(jī)操作屮要改變的數(shù)據(jù)）。2.4內(nèi)部牛成數(shù)據(jù)列出向用戶或開發(fā)單-位屮的

15、維護(hù)調(diào)試人員提供的內(nèi)部生成數(shù)據(jù)。2. 5數(shù)據(jù)約定說明對(duì)數(shù)據(jù)要求的制約。逐條列出對(duì)進(jìn)一步擴(kuò)充或使用方面的考慮而提出的 對(duì)數(shù)據(jù)要求的限制（容量、文卷、記錄和數(shù)據(jù)元的個(gè)數(shù)的最大值）。對(duì)于在設(shè) 計(jì)和開發(fā)中確定是臨界性的限制更要明確指出。3數(shù)據(jù)的采集3. 1要求和范圍按數(shù)據(jù)元的邏輯分組來說明數(shù)據(jù)采集的要求和范圍，指明數(shù)據(jù)的采集方法, 說明數(shù)據(jù)采集工作的承擔(dān)者是用戶還是開發(fā)者。具體的內(nèi)容包括：a. 輸入數(shù)據(jù)的來源，例如是單個(gè)操作員、數(shù)據(jù)輸入站，專業(yè)的數(shù)據(jù) 輸入公司或它們的一個(gè)分組；b. 數(shù)據(jù)輸入（指把數(shù)據(jù)輸入處理系統(tǒng)內(nèi)部）所用的媒體和皺設(shè)備。 如果只有指定的輸入點(diǎn)的輸入才是合法的，則必須對(duì)此加以說明；c.

16、 接受者說明輸出數(shù)據(jù)的接受者；d. 輸出數(shù)據(jù)的形式和設(shè)備列出輸出數(shù)據(jù)的形式和碩設(shè)備。無論接受 者將接收到的數(shù)據(jù)是打印輸出，還是crt上的一組字符、一幀圖形，或一聲警鈴, 或向開關(guān)線圈提供的一個(gè)電脈沖，或常用介質(zhì)如磁盤、磁帶、穿孔卡片等，均應(yīng) 具體說明；e數(shù)據(jù)值的范圍給岀每一個(gè)數(shù)據(jù)元的合法值的范圍；f. 量綱給出數(shù)字的度量單位、增量的步長、零點(diǎn)的定標(biāo)等。在數(shù)據(jù) 是非數(shù)字量的情況下，要給出每一種合法值的形式和含意；g. 更新和處理的頻度給出預(yù)定的對(duì)輸入數(shù)據(jù)的更新和處理的頻度。 如果數(shù)據(jù)的輸入是隨機(jī)的，應(yīng)給出更新處理的頻度的平均值，或變化情況的某種 其他度量。3. 2輸人的承擔(dān)者說明預(yù)定的對(duì)數(shù)據(jù)輸入

17、工作的承擔(dān)者。如果輸入數(shù)據(jù)同某一接口軟件有關(guān)， 述應(yīng)說明該接口軟件的來源。3. 3預(yù)處理對(duì)數(shù)據(jù)的采集和預(yù)處理過程提出專門的規(guī)定，包括適合應(yīng)用的數(shù)據(jù)格式、預(yù) 定的數(shù)據(jù)通信媒體和對(duì)輸入的時(shí)間要求等。對(duì)于需經(jīng)模擬轉(zhuǎn)換或數(shù)字轉(zhuǎn)換處理的 數(shù)據(jù)量，要給出轉(zhuǎn)換方法和轉(zhuǎn)換因了等有關(guān)信息，以便軟件系統(tǒng)使用這些數(shù)據(jù)。3. 4影響說明這些數(shù)據(jù)要求對(duì)于設(shè)備、軟件、用戶、開發(fā)單位所可能產(chǎn)生的影響，例 如耍求用戶單位增設(shè)某個(gè)機(jī)構(gòu)等。文件給制實(shí)施規(guī)定的實(shí)例(gb8567-88)盡管在文件編制中存在著很多靈活性，然而，文件的編制確實(shí)是非常必要的，其意義如前所 這種靈活性，保證文件編制能達(dá)到應(yīng)該達(dá)到的目的，對(duì)于具體的軟件開發(fā)任

18、務(wù)，應(yīng)編制的文件的; 應(yīng)取決于承擔(dān)開發(fā)單位的管理能力、任務(wù)的規(guī)模、復(fù)朵性和成敗風(fēng)險(xiǎn)等因索。一個(gè)軟件開發(fā)單隹 位經(jīng)營承包的應(yīng)用軟件的專業(yè)特點(diǎn)和本單位的管理能力，制定一個(gè)文件編制實(shí)施規(guī)定，說明在什 編制哪些文件。由于國內(nèi)h前在這方而述缺乏成熟的經(jīng)驗(yàn)，這里提供參考國外經(jīng)驗(yàn)制定的兩個(gè)例 軟件開發(fā)單位說明如何建立這種實(shí)施規(guī)定，使項(xiàng)目負(fù)責(zé)人能確定本項(xiàng)目開發(fā)過程屮應(yīng)編制的文纟 例了畢競(jìng)只是例了，這兩個(gè)例了各口都不免有其片面性，它們兩者z間也不免有不一致z處，z 非是供國內(nèi)軟件開發(fā)單位參考。例1:此例規(guī)定用求和法來確定應(yīng)編制的文件。該方法的要點(diǎn)是提出十二個(gè)考慮因素來衡量一個(gè)應(yīng). 個(gè)因素可能取值的范圍是互至5。

19、任務(wù)負(fù)責(zé)人可用這十二個(gè)因素對(duì)所要開發(fā)的程序進(jìn)行衡量，確扌 休值。把這十二個(gè)因素的值相加，得到一個(gè)總和。然后由這個(gè)總和的值來確定應(yīng)該編制的文件斤 個(gè)方法的具體過程如下：a. 按表01中的十二個(gè)因素衡量所要開發(fā)的程序，得到每個(gè)因素的值；b. 把衡量所得的各個(gè)因素的值相加，得總和z值；c. 根據(jù)總和z值，從表0z查岀應(yīng)編制的文件的種類。表1文件編制的十二項(xiàng)衡量因素序 號(hào)因素因素取值準(zhǔn)則123451創(chuàng)造性沒有很少有限相當(dāng)多重大的要求在不同 的設(shè)備上重 編程序具冇嚴(yán) 格的要求具冇新 的接口應(yīng)用現(xiàn) 有的技巧應(yīng)用先 進(jìn)的技巧2通用程 度很強(qiáng)的 限制單 一目標(biāo)有限制 功能的 范圍是參量 化的冇限的 靈活性允許

20、 格式上有某 些變化多用 途，靈活的 格式有一個(gè) 主題領(lǐng)域很靈活 能在不 同的設(shè)備上 處理范圍廣 泛的主題3工作范 圍局部單位分指揮部單個(gè)指 揮部多個(gè)指揮部國防 部，世界范 圍4目標(biāo)范 圍的變化沒有極少偶爾冇經(jīng)常不斷5設(shè)備復(fù) 雜性單機(jī)， 常規(guī)處理單機(jī)， 常規(guī)處理， 擴(kuò)充的外設(shè) 系統(tǒng)多機(jī)， 標(biāo)準(zhǔn)外設(shè)系 統(tǒng)多機(jī)， 復(fù)雜的外設(shè) 系統(tǒng)主機(jī)控 制系統(tǒng)，多 機(jī)，自動(dòng)i/o 和顯示6人員12人35人510 人1018人18人以上7開發(fā)投資6人月 以下6人月 至3人年3人年 至10人年10人年 至30人年30人年 以上8重要程度數(shù)據(jù)處 理常規(guī)過 程控制人身安 全單位成敗國家安 全9對(duì)程序 改變的完成 時(shí)間要求

21、2周以 上12周37天13天24小時(shí) 以內(nèi)10對(duì)數(shù)據(jù) 輸入的響應(yīng) 時(shí)間要求2周以 上12周17天124 小時(shí)60分鐘 內(nèi)11程序語 言高級(jí)語言高級(jí)語 言帶一些匯 編高級(jí)語 言帶相當(dāng)多 的匯編匯編語 言機(jī)器語 言12并行的軟件開發(fā)沒有有限中等程 度很多完全的并行開發(fā)表1文件編制的十二項(xiàng)衡量因索因素 總和可 行性研 究報(bào)告項(xiàng) 目開發(fā) 計(jì)劃軟 件需求 說明書數(shù) 據(jù)要求 說明書概 要設(shè)計(jì) 說明書詳 細(xì)設(shè)計(jì) 說明書數(shù) 據(jù)庫設(shè) 計(jì)說明 書用 戶手冊(cè) （使用 說明）操 作手冊(cè)模 塊開發(fā) 卷宗測(cè) 試設(shè)計(jì)分告 試報(bào)12v*測(cè)試分析報(bào)告應(yīng)該寫，但不必很正規(guī)。*數(shù)據(jù)要求說明和數(shù)據(jù)庫設(shè)計(jì)說明是否需要編寫應(yīng)根據(jù)所開發(fā)軟

22、件的實(shí)際需要來決定。例2：為了避免在軟件開發(fā)中文件編制的不足或過分，一個(gè)簡(jiǎn)便的辦法是把對(duì)軟件文件的編制要求 小聯(lián)系起來，這就是木例的出發(fā)點(diǎn)。軟件的規(guī)模不妨分為四級(jí)：1. 小規(guī)模軟件源程序行數(shù)小于5000的軟件；2. 中規(guī)模軟件源程序行數(shù)為1000050000的軟件；3. 大規(guī)模軟件源程序行數(shù)為100000500000的軟件;4. 特大規(guī)模軟件源程序行數(shù)大于500000的軟件。對(duì)上述的四級(jí)軟件的文件編制要求分別列于表3。至于源程序行數(shù)為500010000, 50000100000的軟件，其文件編制要求介于兩級(jí)z間，n 產(chǎn)品的具體情況，由項(xiàng)目負(fù)責(zé)人參照表3的規(guī)定，確定需要編制的文件種類。對(duì)于源程序

23、行數(shù)大于500000的特大規(guī)模軟件，可進(jìn)一步把木指南規(guī)定的十四種文件按實(shí)際幫 種類。詳細(xì)設(shè)計(jì)說明書(gb856788)1引言11編寫目的說明編寫這份詳細(xì)設(shè)計(jì)說明書的目的，指出預(yù)期的讀者。1.2背景說明：a. 待開發(fā)軟件系統(tǒng)的名稱；b. 本項(xiàng)目的任務(wù)捉出者、開發(fā)者、用戶和運(yùn)行該程序系統(tǒng)的計(jì)算屮心。13定義列出木文件屮用到專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出有關(guān)的參考資料，如：a. 本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b. 屬于本項(xiàng)目的其他己發(fā)表的文件；c 木文件中各處引用到的文件資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題 表口期和出版單位，說明能夠取

24、得這些文件的來源。2程序系統(tǒng)的結(jié)構(gòu)用一系列圖表列出本程序系統(tǒng)內(nèi)的每個(gè)程序（包括每個(gè)模塊和子程序）的名稱、標(biāo)識(shí)符和它 結(jié)構(gòu)關(guān)系。3程序1 （標(biāo)識(shí)符）設(shè)計(jì)說明從本章開始，逐個(gè)地給出各個(gè)層次中的每個(gè)程序的設(shè)計(jì)考慮。以下給出的提綱是針對(duì)一般情; 具體的模塊，尤其是層次比較低的模塊或了程序，其很多條目的內(nèi)容往往與它所隸屈的上一層於 的內(nèi)容相同，在這種情況下，只要簡(jiǎn)單地說明這一點(diǎn)即可。3. 1程序描述給岀對(duì)該程序的簡(jiǎn)耍描述，主耍說明安排設(shè)計(jì)木程序的目的意義，并且，還耍說明木程序的! 駐內(nèi)存還是非常駐？是否子程序？是可重人的還是不可重人的？有無覆蓋要求？是順序處理還是說明該程序應(yīng)具有的功能，可采用ipo圖（

25、即輸入一處理一輸出圖）的形式。3. 3性能說明對(duì)該程序的全部性能要求，包描對(duì)精度、靈活性和時(shí)間特性的要求。3.4輸人項(xiàng)給出對(duì)每一個(gè)輸入項(xiàng)的特性，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸, 和頻度、輸入媒體、輸入數(shù)據(jù)的來源和安全保密條件等等。3.5輸出項(xiàng)給出對(duì)每一個(gè)輸出項(xiàng)的特性，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍，輸 和頻度，輸出媒體、對(duì)輸出圖形及符號(hào)的說明、安全保密條件等等。3. 6算法詳細(xì)說明本程序所選用的算法，具體的計(jì)算公式和計(jì)算步驟。3. 7流程邏輯用圖表（例如流程圖、判定表等）輔以必要的說明來表示木程序的邏輯流程。3.8 接口用圖的形式說明本程序所隸屬的上

26、一層模塊及隸屬于本程序的下一層模塊、子程序，說明參匚 式，說明與木程序相直接關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)（數(shù)據(jù)庫、數(shù)據(jù)文卷）。3. 9存儲(chǔ)分配根據(jù)需要，說明本程序的存儲(chǔ)分配。3. 10注釋設(shè)計(jì)說明準(zhǔn)備在本程序中安排的注釋，如：a. 加在模塊首部的注釋；b. 加在各分枝點(diǎn)處的注釋；c. 對(duì)各變量的功能、范圍、缺省條件等所加的注釋；d. 對(duì)使用的邏輯所加的注釋等等。說明木程序運(yùn)行中所受到的限制條件。3. 12測(cè)試計(jì)劃說明對(duì)本程序進(jìn)行單體測(cè)試的計(jì)劃，包描對(duì)測(cè)試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安: 設(shè)備條件驅(qū)動(dòng)程序及樁模塊等的規(guī)定。3. 13尚未解決的問題說明在本程序的設(shè)計(jì)小尚未解決而設(shè)計(jì)者認(rèn)為在軟件完成z前應(yīng)

27、解決的問題。4程序2 (標(biāo)識(shí)符)設(shè)計(jì)說明項(xiàng)目開發(fā)計(jì)劃(gb856t88)1、引言1.1編寫目的說明：編寫這份軟件項(xiàng)目開發(fā)計(jì)劃的目的，并指出預(yù)期的讀者。1.2背景說明：a. 待開發(fā)的軟件系統(tǒng)的名稱；b. 本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)該軟件的計(jì)算中心或計(jì)算機(jī)網(wǎng)絡(luò)；c. 該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基木的相互來往關(guān)系。13定義列出木文件中用到的專門術(shù)語的定義和外文的首字母組詞的原詞組。1.4參考資料列岀用得著的參考資料，如：a. 本項(xiàng)口的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書和合同、上級(jí)機(jī)關(guān)的批文；b. 屈于本項(xiàng)目的其他已發(fā)表的文件；c. 本文件中各處引用的文件、資料，包描所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些

28、文件鄉(xiāng) 件編號(hào)、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2項(xiàng)目概述2. 1工作內(nèi)容簡(jiǎn)要地說明在本項(xiàng)目的開發(fā)中須進(jìn)行的各項(xiàng)主要工作。2. 2主要參加人員扼要說明參加本項(xiàng)冃開發(fā)的主要人員的情況，包括他們的技術(shù)水平。2.3產(chǎn)品2. 3. 1程序列出須移交給用戶的程序的名稱、所用地編程語言及存儲(chǔ)程序的媒體形式，并通過引用;說明其功能和能力。2. 3. 2文件列出須移交用戶的每種文件的名稱及內(nèi)容耍點(diǎn)。2. 3. 3服務(wù)列出需向用戶提供的各項(xiàng)服務(wù)，如培訓(xùn)安裝、維護(hù)和運(yùn)行支持等，應(yīng)逐項(xiàng)規(guī)定開始日期、 級(jí)別和服務(wù)的期限。2. 3. 4非移交的產(chǎn)品說明開發(fā)集體應(yīng)向本單位交出但不必向用戶移交的產(chǎn)品（文

29、件甚至某些程序）。2. 4驗(yàn)收標(biāo)準(zhǔn)對(duì)于上述這些應(yīng)交出的產(chǎn)品和服務(wù)，逐項(xiàng)說明或引用資料說明驗(yàn)收標(biāo)準(zhǔn)。2. 5完成項(xiàng)目的最遲期限2. 6本計(jì)劃的批準(zhǔn)者和批準(zhǔn)日期3實(shí)施計(jì)劃3. 1工作任務(wù)的分解與人員分工對(duì)于項(xiàng)目開發(fā)中需要完成的各項(xiàng)工作，從需求分析、設(shè)計(jì)、實(shí)現(xiàn)、測(cè)試直到維護(hù)，包扌匸 批、打印、分發(fā)工作，用戶培訓(xùn)工作，軟件安裝工作等，按層次進(jìn)行分解，指明每項(xiàng)任務(wù)的負(fù)責(zé).負(fù)責(zé)接口工作的人員及他們的職責(zé)，包括：3負(fù)責(zé)本項(xiàng)目同用戶的接口人員；b. 本項(xiàng)目同本單位各管理機(jī)構(gòu)，如合同計(jì)劃管理部門、財(cái)務(wù)部門、質(zhì)量管理部門等的接口丿c. 負(fù)責(zé)木項(xiàng)口同個(gè)份合同負(fù)責(zé)單位的接口人員等。3. 3進(jìn)度對(duì)于需求分析、設(shè)計(jì)、編碼

30、實(shí)現(xiàn)、測(cè)試、移交、培訓(xùn)和安裝等工作，給出每項(xiàng)工作任務(wù)邸 完成日期及所需資源，規(guī)定各項(xiàng)工作任務(wù)完成的先后順序以及表征每項(xiàng)工作任務(wù)完成的標(biāo)志性事 程碑）。3.4預(yù)算逐項(xiàng)列出本開發(fā)項(xiàng)冃所需要的勞務(wù)（包括人員的數(shù)量和時(shí)間）以及經(jīng)費(fèi)的預(yù)算（包括辦: 機(jī)時(shí)費(fèi)、資料費(fèi)、通訊設(shè)備和專用設(shè)備的租金等）和來源。3.5關(guān)鍵問題逐項(xiàng)列出能夠影響整個(gè)項(xiàng)目成敗的關(guān)鍵問題、技術(shù)難點(diǎn)和風(fēng)險(xiǎn)，指出這些問題對(duì)項(xiàng)目的4支持條件說明為支持本項(xiàng)h的開發(fā)所需要的各種條件和設(shè)施。4.1計(jì)算機(jī)系統(tǒng)支持逐項(xiàng)列出開發(fā)中和運(yùn)行時(shí)所需的計(jì)算機(jī)系統(tǒng)支持，包括計(jì)算機(jī)、外圍設(shè)備、通訊設(shè)備、模 匯編）程序、操作系統(tǒng)、數(shù)據(jù)管理程序包、數(shù)據(jù)存儲(chǔ)能力和測(cè)試支持能

31、力等，逐項(xiàng)給出有關(guān)到貨 的耍求。4. 2需曲用戶承擔(dān)的工作逐項(xiàng)列出需要用戶樂擔(dān)的工作和完成期限。包括需由用戶提供的條件及提供時(shí)間。4. 3由外單位提供的條件逐項(xiàng)列出需要外單位分合同承包者承擔(dān)的工作和完成的時(shí)間，包插需要由外單位提供的7 間。5專題計(jì)劃要點(diǎn)說明本項(xiàng)口開發(fā)中需制定的各個(gè)專題計(jì)劃（如分合同計(jì)劃、開發(fā)人員培訓(xùn)計(jì)劃、測(cè)試計(jì): 劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、用戶培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等）的要點(diǎn)。用類似f3的方式，說明第2個(gè)程序乃至第n個(gè)程序的設(shè)計(jì)考慮。項(xiàng)目開發(fā)總結(jié)報(bào)告(gb856788)1引言11編寫目的說明編寫這份項(xiàng)目開發(fā)總結(jié)報(bào)告的目的，指出預(yù)期的閱讀范圍。12背景說明：a. 木項(xiàng)口的

32、名稱和所開發(fā)出來的軟件系統(tǒng)的名稱；b. 此軟件的任務(wù)提出者、開發(fā)者、用戶及安裝此軟件的計(jì)算中心。13定義列出本文件屮用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1. 4參考資料列岀耍用到的參考資料，如：a. 本項(xiàng)目的已核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b. 厲于本項(xiàng)目的其他已發(fā)表的文件；c. 本文件屮各處所引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo) 發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2實(shí)際開發(fā)結(jié)果2. 產(chǎn)品說明最終制成的產(chǎn)品，包括：a. 程序系統(tǒng)中各個(gè)程序的名字，它們之間的層次關(guān)系，以千字節(jié)為單位的各個(gè)程序的程序 形式和數(shù)量；b. 程序系統(tǒng)共有哪幾

33、個(gè)版木，各自的版木號(hào)及它們之間的區(qū)別;c.每個(gè)文件的名稱;d. 所建立的每個(gè)數(shù)據(jù)庫。如果開發(fā)屮制訂過配置管理計(jì)劃，要同這個(gè)計(jì)劃相比較。2. 2主要功能和性能逐項(xiàng)列出木軟件產(chǎn)品所實(shí)際具有的主要功能和性能，對(duì)照可行性研究報(bào)告、項(xiàng)口開發(fā)計(jì)劃、: 的有關(guān)內(nèi)容，說明原定的開發(fā)目標(biāo)是達(dá)到了、未完全達(dá)到、或超過了。2. 3基本流程用圖給出本程序系統(tǒng)的實(shí)際的基本的處理流程。2. 4進(jìn)度列岀原定計(jì)劃進(jìn)度與實(shí)際進(jìn)度的對(duì)比，明確說明，實(shí)際進(jìn)度是提前了、還是延遲了，分析主2. 5費(fèi)用列出原定計(jì)劃費(fèi)用與實(shí)際支出費(fèi)用的對(duì)比，包括：a. 工時(shí)，以人月為單位，并按不同級(jí)別統(tǒng)計(jì)；b. 計(jì)算機(jī)的使用時(shí)間，區(qū)別cpu時(shí)間及其他設(shè)備

34、時(shí)間；c. 物料消耗、出差費(fèi)等其他支出。明確說明，經(jīng)費(fèi)是超出了、還是節(jié)余了，分析其主要原因。3開發(fā)工作評(píng)價(jià)3. 1對(duì)生產(chǎn)效率的評(píng)價(jià)給出實(shí)際生產(chǎn)效率，包扌舌：a. 程序的平均生產(chǎn)效率，即每人月生產(chǎn)的行數(shù)；b. 文件的平均生產(chǎn)效率，即每人月生產(chǎn)的千字?jǐn)?shù)；并列出原訂計(jì)劃數(shù)作為對(duì)比。3. 2對(duì)產(chǎn)品質(zhì)量的評(píng)價(jià)說明在測(cè)試中檢查出來的程序編制中的錯(cuò)誤發(fā)生率，即每干條指令（或語句）中的錯(cuò)誤指令歩 如果開發(fā)屮制訂過質(zhì)量保證計(jì)劃或配置管理計(jì)劃，要同這些計(jì)劃相比較。3. 3對(duì)技術(shù)方法的評(píng)價(jià)給岀對(duì)在開發(fā)中所使用的技術(shù)、方法、工具、手段的評(píng)價(jià)。3. 4出錯(cuò)原因的分析給出對(duì)于開發(fā)屮出現(xiàn)的錯(cuò)誤的原因分析。4經(jīng)驗(yàn)與教訓(xùn)列出從

35、這項(xiàng)開發(fā)工作中所得到的最主要的經(jīng)驗(yàn)與教訓(xùn)及對(duì)今后的項(xiàng)目開發(fā)工作的建用戶手冊(cè)(gb856788)1引言1.1編寫目的說明編寫這份用戶手冊(cè)的口的，指出預(yù)期的讀者。12背景說明：a. 這份用戶手冊(cè)所描述的軟件系統(tǒng)的名稱；b. 該軟件項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶(或首批用戶)及安裝此軟件的計(jì)算中龍13定義列岀本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1. 4參考資料列出有用的參考資料，女山a. 項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b. 屈于木項(xiàng)目的其他已發(fā)表文件；c. 本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件鄉(xiāng) 件編號(hào)、發(fā)表日期和出版單位，說明能

36、夠取得這些文件資料的來源。2用途2. 1功能結(jié)合本軟件的開發(fā)目的逐項(xiàng)地說明本軟件所具有各項(xiàng)功能以及它們的極限范圍。2. 2性能2. 2. 1精度逐項(xiàng)說明對(duì)各項(xiàng)輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達(dá)到的精度，包括傳輸中的精度要求2. 2. 2時(shí)間特性定量地說明本軟件的時(shí)間特性，如響應(yīng)時(shí)間，更新處理時(shí)間，數(shù)據(jù)傳輸、轉(zhuǎn)換時(shí)間，計(jì)算時(shí)2. 2. 3靈活性說明木軟件所具有的靈活性，即當(dāng)用戶需求（如對(duì)操作方式、運(yùn)行環(huán)境、結(jié)果精度、時(shí)間特, 某些變化時(shí)，本軟件的適應(yīng)能力。2. 3安全保密說明本軟件在安全、保密方面的設(shè)計(jì)考慮和實(shí)際達(dá)到的能力。3運(yùn)行環(huán)境3. 1硬設(shè)備列岀為運(yùn)行本軟件所要求的皺設(shè)備的最小配置，如：

37、a. 處理機(jī)的型號(hào)、內(nèi)存容量；b. 所要求的外存儲(chǔ)器、媒體、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)、聯(lián)機(jī)/脫機(jī)；c. i/o設(shè)備（聯(lián)機(jī)/脫機(jī)？）；d. 數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。3. 2支持軟件說明為運(yùn)行本軟件所需要的支持軟件，如：a. 操作系統(tǒng)的名稱、版本號(hào)；b. 程序語言的編譯/匯編系統(tǒng)的名稱和版本號(hào)；c. 數(shù)據(jù)庫管理系統(tǒng)的名稱和版本號(hào)；d. 其他支持軟件。3. 3數(shù)據(jù)結(jié)構(gòu)列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫或數(shù)據(jù)文卷。4使用過程在本章，首先用圖表的形式說明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、輸出接收機(jī)構(gòu)之間的關(guān)系4. 1安裝與初始化一步一步地說明為使用本軟件而需進(jìn)行的安裝與初始化過程，包括程序的存儲(chǔ)形式、安裝與; 全部操作命令、系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)。表征安裝工作完成的測(cè)試實(shí)例等。如果有的話，： 程屮所需用到的專用軟件。4. 2輸入規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。4