軟件設(shè)計國家標準 文檔及軟件開發(fā)文檔之詳細設(shè)計說明書

操作手冊（GB8567——88）1引言1.1編寫目的說明編寫這份操作手冊的目的，指出預期的讀者。1.2前景說明：a．

這份操作手冊所描述的軟件系統(tǒng)的名稱；b．

該軟件項目的任務提出者、開發(fā)者、用戶（或首批用戶）及安裝該軟件的計算中心。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出有用的參考資料，如：a．

本項目的經(jīng)核準的計劃任務書或合同、上級機關(guān)的批文；b．

屬于本項目的其他已發(fā)表的文件；c．

本文件中各處引用的文件、資料，包括所列出的這些文件資料的標題、文件編號、發(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)對這些命令的反應與答復，表征安裝工作完成的測試實例等。如果有的話，還應說明安裝過程中所需用到的專用軟件。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.

啟動方法如應請啟動（由所遇到的請求信息啟動）、預定時間啟動、…，··等；d.

預計的運行時間和解題時間；e.

操作命令；f.

與運行有聯(lián)系的其他事項。4.3.3輸入一輸出文卷提供被本運行建立、更新或訪問的數(shù)據(jù)文卷的有關(guān)信息，如：a.

文卷的標識符或標號；b.

記錄媒體；c.

存留的目錄表；d.

文卷的支配如確定保留或廢棄的準則、是否要分配給其他接受者、占用硬設(shè)備的優(yōu)先級以及保密控制等有關(guān)規(guī)定。4.3.4輸出文段提供本軟件輸出的每一一個用于提示、說明、或應答的文段（包括“菜單”）的有關(guān)信息，如：a.

文段的標識符；b.

輸出媒體（屏幕顯示、打印、……）；c.

文字容量；d.

分發(fā)對象；e.

保密要求。4.3.5輸出文段的復制對由計算機產(chǎn)生，而后需用其他方法復制的那些文段提供有關(guān)信息，如：a.文段的標識符；b.復制的技術(shù)手段；c.紙張或其他媒體的規(guī)格；d.裝訂要求；e.分發(fā)對象；f.

復制份數(shù)。4.3.6恢復過程說明本運行故障后的恢復過程。4.4運行2（標識符）說明用與本手冊4.3條相類似的方式介紹另一個運行的有關(guān)信息。5非常規(guī)過程提供有關(guān)應急操作或非常規(guī)操作的必要信息，如出錯處理操作、向后備系統(tǒng)的切換操作以及其他必須向程序維護人員交待的事項和步驟。6遠程操作如果本軟件能夠通過遠程終端控制運行，則在本章說明通過遠程終端運行本軟件的操作過程。

測試分析報告（GB8567——88）1引言1.1編寫目的說明這份測試分析報告的具體編寫目的，指出預期的閱讀范圍。1.2背景說明：a.

被測試軟件系統(tǒng)的名稱；b.

該軟件的任務提出者、開發(fā)者、用戶及安裝此軟件的計算中心，指出測試環(huán)境與實際運行環(huán)境之間可能存在的差異以及這些差異對測試結(jié)果的影響。1.3定義列出本文件中用到的專問術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出要用到的參考資料，如：a．本項目的經(jīng)核準的計劃任務書或合同、上級機關(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.1功能1（標識符）4.1.1能力簡述該項功能，說明為滿足此項功能而設(shè)計的軟件能力以及經(jīng)過一項或多項測試已證實的能力。4.1.2限制說明測試數(shù)據(jù)值的范圍（包括動態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)），列出就這項功能而言，測試期間在該軟件中查出的缺陷、局限性。4.2功能2（標識符）用類似本報告4.l的方式給出第2項及其后各項功能的測試結(jié)論。．．．．5分析摘要5.1能力陳述經(jīng)測試證實了的本軟件的能力。如果所進行的測試是為了驗證一項或幾項特定性能要求的實現(xiàn)，應提供這方面的測試結(jié)果與要求之間的比較，并確定測試環(huán)境與實際運行環(huán)境之間可能存在的差異對能力的測試所帶來的影響。5.2缺陷和限制陳述經(jīng)測試證實的軟件缺陷和限制，說明每項缺陷和限制對軟件性能的影響，并說明全部測得的性能缺陷的累積影響和總影響。5.3建議對每項缺陷提出改進建議，如：a．各項修改可采用的修改方法；b．各項修改的緊迫程度；c．各項修改預計的工作量；d．各項修改的負責人。5.4評價說明該項軟件的開發(fā)是否已達到預定目標，能否交付使用。6測試資源消耗總結(jié)測試工作的資源消耗數(shù)據(jù)，如工作人員的水平級別數(shù)量、機時消耗等。

測試計劃（GB8567——88）1引言1.1編寫目的本測試計劃的具體編寫目的，指出預期的讀者范圍。1.2背景說明：a．測試計劃所從屬的軟件系統(tǒng)的名稱；b．該開發(fā)項目的歷史，列出用戶和執(zhí)行此項目測試的計算中心，說明在開始執(zhí)行本測試計劃之前必須完成的各項工作。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出要用到的參考資料，如：a．本項目的經(jīng)核準的計劃任務書或合同、上級機關(guān)的批文；b．屬于本項目的其他已發(fā)表的文件；c．本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標準。列出這些文件的標題、文件編號、發(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.2條件陳述本項測試工作對資源的要求，包括：a．

設(shè)備所用到的設(shè)備類型、數(shù)量和預定使用時間；b．

軟件列出將被用來支持本項測試過程而本身又并不是被測軟件的組成部分的軟件，如測試驅(qū)動程序、測試監(jiān)控程序、仿真程序、樁模塊等等；c．

人員列出在測試工作期間預期可由用戶和開發(fā)任務組提供的工作人員的人數(shù)。技術(shù)水平及有關(guān)的預備知識，包括一些特殊要求，如倒班操作和數(shù)據(jù)鍵入人員。2.3.3測試資料列出本項測試所需的資料，如：a．

有關(guān)本項任務的文件；b．

被測試程序及其所在的媒體；c．

測試的輸入和輸出舉例；d．

有關(guān)控制此項測試的方法、過程的圖表。2.3.4測試培訓說明或引用資料說明為被測軟件的使用提供培訓的計劃。規(guī)定培訓的內(nèi)容、受訓的人員及從事培訓的工作人員。2.4測試2（標識符）用與本測試計劃2.3條相類似的方式說明用于另一項及其后各項測試內(nèi)容的測試工作計劃。3測試設(shè)計說明3.1測試1（標識符）說明對第一項測試內(nèi)容的測試設(shè)計考慮。3.1.1控制說明本測試的控制方式，如輸入是人工、半自動或自動引入、控制操作的順序以及結(jié)果的記錄方法。3.1.2輸入說明本項測試中所使用的輸入數(shù)據(jù)及選擇這些輸入數(shù)據(jù)的策略。3.1.3輸出說明預期的輸出數(shù)據(jù)，如測試結(jié)果及可能產(chǎn)生的中間結(jié)果或運行信息。3.1.4過程說明完成此項測試的一個個步驟和控制命令，包括測試的準備、初始化、中間步聚和運行結(jié)束方式。3.2測試2（標識符）用與本測試計劃3.l條相類似的方式說明第2項及其后各項測試工作的設(shè)計考慮。4評價準則4.1范圍說明所選擇的測試用例能夠接查的范圍及其局限性。4.2數(shù)據(jù)整理陳述為了把測試數(shù)據(jù)加工成便于評價的適當形式，使得測試結(jié)果可以同，已知結(jié)果進行比較而要用到的轉(zhuǎn)換處理技術(shù)，如手工方式或自動方式；如果是用自動方式整理數(shù)據(jù)，還要說明為進行處理而要用到的硬件、軟件資源。4.3尺度說明用來判斷測試工作是否能通過的評價尺度，如合理的輸出結(jié)果的類型、測試輸出結(jié)果與預期輸出之間的容許偏離范圍、允許中斷或停機的最大次數(shù)。

概要設(shè)計說明書（GB8567——88）1引言1.1編寫目的說明編寫這份概要設(shè)計說明書的目的，指出預期的讀者。1.2背景說明：a.

待開發(fā)軟件系統(tǒng)的名稱；b.

列出此項目的任務提出者、開發(fā)者、用戶以及將運行該軟件的計算站（中心）。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出有關(guān)的參考文件，如：a.本項目的經(jīng)核準的計劃任務書或合同，上級機關(guān)的批文；b.屬于本項目的其他已發(fā)表文件；c.本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標準。列出這些文件的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2總體設(shè)計2.1需求規(guī)定說明對本系統(tǒng)的主要的輸入輸出項目、處理的功能性能要求，詳細的說明可參見附錄C。2.2運行環(huán)境簡要地說明對本系統(tǒng)的運行環(huán)境（包括硬件環(huán)境和支持環(huán)境）的規(guī)定，詳細說明參見附錄C。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)系：

程序1程序2……程序n功能需求1√

功能需求2

√

……

功能需求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ù)，當原始系統(tǒng)數(shù)據(jù)萬一丟失時啟用的副本的建立和啟動的技術(shù)，例如周期性地把磁盤信息記錄到磁帶上去就是對于磁盤媒體的一種后備技術(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)的檢查與維護的檢測點和專用模塊。各個程序之間的對應關(guān)系，可采用如下的矩陣圖的形式；

開發(fā)進度月報（GB8567——88）1、標題開發(fā)中的軟件系統(tǒng)的名稱和標識符分項目名稱和標識符分項目負責人簽名本期月報編寫人簽名本期月報的編號及所報告的年月2、工程進度與狀態(tài)2.1進度列出本月內(nèi)進行的各項主要活動，并且說明本月內(nèi)遇到的重要事件，這里所說的重要事件是指一個開發(fā)階段（即軟件生存周期內(nèi)各個階段中的某一個，例如需求分析階段）的開始或結(jié)束，要說明階段名稱及開始（或結(jié)束）的日期。2.2狀態(tài)說明本月的實際工作進度與計劃相比，是提前了、按期完成了、或是推遲了？如果與計劃不一致，說明原因及準備采取的措施。3資額耗用與狀態(tài)3.1資額耗用主要說明本月份內(nèi)耗用的工時與機時。3.1.1工時分為三類：a．

管理用工時包括在項目管理（制訂計劃、布置工作、收集數(shù)據(jù)、檢查匯報工作等）方面耗用的工時；b．

服務工時包括為支持項目開發(fā)所必須的服務工作及非直接的開發(fā)工作所耗用的工時；c．

開發(fā)用工時要分各個開發(fā)階段填寫。3.1.2機時說明本月內(nèi)耗用的機時，以小時為單位，說明計算機系統(tǒng)的型號。3.2狀態(tài)說明本月內(nèi)實際耗用的資源與計劃相比，是超出了、相一致、還是不到計劃數(shù)？如果與計劃不一致，說明原因及準備采取的措施。4經(jīng)費支出與狀態(tài)4.1經(jīng)費支出4.1.1支持性費用列出本月內(nèi)支出的支持性費用，一般可按如下七類列出，并給出本月支持費用的總和：a.房租或房屋折舊費；b.社工資、獎金、補貼；c.培訓費包括給教師的酬金及教室租金；d.資料費包括復印及購買參考資料的費用；e.會議費召集有關(guān)業(yè)務會議的費用；f.

旅差費；g.其他費用。4.1.2設(shè)備購置費列出本月內(nèi)支出的設(shè)備購置費，一般可分如下三類：a．購買軟件的名稱與金額；b．購買硬設(shè)備的名稱、型號、數(shù)量及金額；c．已有硬設(shè)備的折舊費。4.2狀態(tài)說明本月內(nèi)實際支出的經(jīng)費與計劃相比較，是超過了。相符合、還是不到計劃數(shù)？如果與計劃不一致，說明原因及準備采取的措施。5下個月的工作計劃6建議本月遇到的重要問題和應引起重視的問題以及因此產(chǎn)生的建議。

可行性研究報告GB8567——881引言 1.1編寫目的說明編寫本可行性研究報告的目的，指出預期的讀者。1.2背景說明：A.

所建議開發(fā)的軟件系統(tǒng)的名稱；B.

本項目的任務提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機網(wǎng)絡(luò)；C.該軟件系統(tǒng)同其他系統(tǒng)或其他機構(gòu)的基本的相互來往關(guān)系。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出用得著的參考資料，如：1.

本項目的經(jīng)核準的計劃任務書或合同、上級機關(guān)的批文；2.

屬于本項目的其他已發(fā)表的文件；3.

本文件中各處引用的文件、資料，包括所需用到的軟件開發(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.

管理信息服務的改進；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)是指當前實際使用的系統(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)所承擔的工作及工作量。3.3費用開支列出由于運行現(xiàn)有系統(tǒng)所引起的費用開支，如人力、設(shè)備、空間、支持性服務、材料等項開支以及開支總額。3.4人員列出為了現(xiàn)有系統(tǒng)的運行和維護所需要的人員的專業(yè)技術(shù)類別和數(shù)量。3.5設(shè)備列出現(xiàn)有系統(tǒng)所使用的各種設(shè)備。3.6局限性列出本系統(tǒng)的主要的局限性，例如處理時間趕不上需要，響應不及時，數(shù)據(jù)存儲能力不足，處理功能不夠等。并且要說明，為什么對現(xiàn)有系統(tǒng)的改進性維護已經(jīng)不能解決問題。4所建議的系統(tǒng)本章將用來說明所建議系統(tǒng)的目標和要求將如何被滿足。4.1對所建議系統(tǒng)的說明概括地說明所建議系統(tǒng)，并說明在第2章中列出的那些要求將如何得到滿足，說明所使用的基本方法及理論根據(jù)。4.2處理流程和數(shù)據(jù)流程給出所建議系統(tǒng)的處理流程和數(shù)據(jù)流程。4.3改進之處按2.2條中列出的目標，逐項說明所建議系統(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)存的應用軟件和支持軟件能夠同所建議系統(tǒ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ù)存儲、恢復的處理；g．輸出報告的處理過程、存儲媒體和調(diào)度方法；h．系統(tǒng)失效的后果及恢復的處理辦法。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é)應說明技術(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)方案，包括需開發(fā)的和可從國內(nèi)國外直接購買的，如果沒有供選擇的系統(tǒng)方案可考慮，則說明這一點。5.1可選擇的系統(tǒng)方案1參照第4章的提綱，說明可選擇的系統(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)的和應用的軟件；g.

數(shù)據(jù)庫管理軟件。6.1.2其他一次性支出包括下列各項所需的費用，如：a．研究（需求的研究和設(shè)計的研究）；b．開發(fā)計劃與測量基準的研究；c．數(shù)據(jù)庫的建立；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)常性的支出等。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．價值的增升包括由于一個應用系統(tǒng)的使用價值的增升所引起的收益，如資源利用的改進，管理和運行效率的改進以及出錯率的減少等；c．其他如從多余設(shè)備出售回收的收入等。6.2.2非一次性收益說明在整個系統(tǒng)生命期內(nèi)由于運行所建議系統(tǒng)而導致的按月的、按年的能用人民幣數(shù)目表示的收益，包括開支的減少和避免。6.2.3不可定量的收益逐項列出無法直接用人民幣表示的收益，如服務的改進，由操作失誤引起的風險的減少，信息掌握情況的改進，組織機構(gòu)給外界形象的改善等。有些不可捉摸的收益只能大概估計或進行極值估計（按最好和最差情況估計）。6.3收益／投資比求出整個系統(tǒng)生命期的收益／投資比值。6.4投資回收周期求出收益的累計數(shù)開始超過支出的累計數(shù)的時間。6.5敏感性分析所謂敏感性分析是指一些關(guān)鍵性因素如系統(tǒng)生命期長度、系統(tǒng)的工作負荷量、工作負荷的類型與這些不同類型之間的合理搭配、處理速度要求、設(shè)備和軟件的配置等變化時，對開支和收益的影響最靈敏的范圍的估計。在敏感性分析的基礎(chǔ)上做出的選擇當然會比單一選擇的結(jié)果要好一些。7社會因素方面的可行性本章用來說明對社會因素方面的可行性分析的結(jié)果，包括：7.1法律方面的可行性法律方面的可行性問題很多，如合同責任、侵犯專利權(quán)、侵犯版權(quán)等方面的陷井，軟件人員通常是不熟悉的，有可能陷入，務必要注意研究。7.2使用方面的可行性例如從用戶單位的行政管理、工作制度等方面來看，是否能夠使用該軟件系統(tǒng)；從用戶單位的工作人員的素質(zhì)來看，是否能滿足使用該軟件系統(tǒng)的要求等等，都是要考慮的。8結(jié)論在進行可行性研究報告的編制時，必須有一個研究的結(jié)論。結(jié)論可以是：a．可以立即開始進行；b．需要推遲到某些條件（例如資金、人力、設(shè)備等）落實之后才能開始進行；c．需要對開發(fā)目標進行某些修改之后才能開始進行；d．不能進行或不必進行（例如因技術(shù)不成熟、經(jīng)濟上不合算等）。

模塊開發(fā)卷宗（GB8567——88）1標題軟件系統(tǒng)名稱和標識符模塊名稱和標識符（如果本卷宗包含多于一個的模塊，則用這組模塊的功能標識代替模塊名）程序編制員簽名卷宗的修改文本序號修改完成日期卷宗序號（說明本卷宗在整個卷宗中的序號）編排日期（說明整個卷宗最近的一次編排日期）2模塊開發(fā)情況表3功能說明扼要說明本模塊（或本組模塊）的功能，主要是輸入、要求的處理、輸出?？梢詮南到y(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)生的本模塊（或本組模塊）的第一份無語法錯的源代碼清單以及已通過全部測試的當前有效的源代碼清單。6測試說明說明直接要經(jīng)過本模塊（或本組模塊）的每一項測試，包括這些測試各自的標識符和編號、進行這些測試的目的、所用的配置和輸入、預期的輸出及實際的輸出。7復審的結(jié)論把實際測試的結(jié)果，同軟件需求說明書、系統(tǒng)設(shè)計說明書、程序設(shè)計說明書中規(guī)定的要求進行比較和給出結(jié)論。

軟件需求說明書的編寫提示（GB856T——88）1引言1.1編寫目的說明編寫這份軟件需求說明書的目的，指出預期的讀者。1.2背景說明：a．

待開發(fā)的軟件系統(tǒng)的名稱；b．

本項目的任務提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機網(wǎng)絡(luò)；c．

該軟件系統(tǒng)同其他系統(tǒng)或其他機構(gòu)的基本的相互來往關(guān)系。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出用得著的參考資料，如：a．

本項目的經(jīng)核準的計劃任務書或合同、上級機關(guān)的批文；b．

屬于本項目的其他已發(fā)表的文件；c．

本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2任務概述2.1目標敘述該項軟件開發(fā)的意圖、應用目標、作用范圍以及其他應向讀者說明的有關(guān)該軟件開發(fā)的背景材料。解釋被開發(fā)軟件與其他有關(guān)軟件之間的關(guān)系。如果本軟件產(chǎn)品是一項獨立的軟件，而且全部內(nèi)容自含，則說明這一點。如果所定義的產(chǎn)品是一個更大的系統(tǒng)的一個組成部分，則應說明本產(chǎn)品與該系統(tǒng)中其他各組成部分之間的關(guān)系，為此可使用一張方框圖來說明該系統(tǒng)的組成和本產(chǎn)品同其他各部分的聯(lián)系和接口。|2.2用戶的特點列出本軟件的最終用戶的特點，充分說明操作人員、維護人員的教育水平和技術(shù)專長，以及本軟件的預期使甩頻度。這些是軟件設(shè)計工作的重要約束2.3假定和約束列出進行本軟件開發(fā)工作的假定和約束，例如經(jīng)費限制、開發(fā)期限等。3需求規(guī)定3.1對功能的規(guī)定用列表的方式（例如IPO表即輸入、處理、輸出表的形式），逐項定量和定性地敘述對軟件所提出的功能要求，說明輸入什么量、經(jīng)怎樣的處理、得到什么輸出，說明軟件應支持的終端數(shù)和應支持的并行操作的用戶數(shù)。3.2對性能的規(guī)定3.2.1精度說明對該軟件的輸入、輸出數(shù)據(jù)精度的要求，可能包括傳輸過程中的精度。3.2.2時間特性要求說明對于該軟件的時間特性要求，如對：a．

響應時間；b．

更新處理時間；c．

數(shù)據(jù)的轉(zhuǎn)換和傳送時間；d．

解題時間；等的要求。3.2.3靈活性說明對該軟件的靈活性的要求，即當需求發(fā)生某些變化時，該軟件對這些變化的適應能力，如：a．

操作方式上的變化；b．

運行環(huán)境的變化；c．

同其他軟件的接口的變化；d．

精度和有效時限的變化；e．

計劃的變化或改進。對于為了提供這些靈活性而進行的專門設(shè)計的部分應該加以標明。3.3輸人輸出要求解釋各輸入輸出數(shù)據(jù)類型，并逐項說明其媒體、格式、數(shù)值范圍、精度等。對軟件的數(shù)據(jù)輸出及必須標明的控制輸出量進行解釋并舉例，包括對硬拷貝報告（正常結(jié)果輸出、狀態(tài)輸出及異常輸出）以及圖形或顯示報告的描述。3.4數(shù)據(jù)管理能力要求說明需要管理的文卷和記錄的個數(shù)、表和文卷的大小規(guī)模，要按可預見的增長對數(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控制說明控制該軟件的運行的方法和控制信號，并說明這些控制信號的來源。

數(shù)據(jù)庫設(shè)計說明書（GB8567——88）1引言1.1編寫目的說明編寫這份數(shù)據(jù)庫設(shè)計說明書的目的，指出預期的讀者。1.2背景說明：a．

說明待開發(fā)的數(shù)據(jù)庫的名稱和使用此數(shù)據(jù)庫的軟件系統(tǒng)的名稱；b．

列出該軟件系統(tǒng)開發(fā)項目的任務提出者、用戶以及將安裝該軟件和這個數(shù)據(jù)庫的計算站（中心）。1.3定義列出本文件中用到的專門術(shù)語的定義、外文首字母組詞的原詞組。1.4參考資料列出有關(guān)的參考資料：a．

本項目的經(jīng)核準的計劃任務書或合同、上級機關(guān)批文；b．

屬于本項目的其他已發(fā)表的文件；c．

本文件中各處引用到的文件資料，包括所要用到的軟件開發(fā)標準。列出這些文件的標題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件的來源。2外部設(shè)計2.1標識符和狀態(tài)聯(lián)系用途，詳細說明用于唯一地標識該數(shù)據(jù)庫的代碼、名稱或標識符，附加的描述性信息亦要給出。如果該數(shù)據(jù)庫屬于尚在實驗中、尚在測試中或是暫時使用的，則要說明這一特點及其有效時間范圍。2.2使用它的程序列出將要使用或訪問此數(shù)據(jù)庫的所有應用程序，對于這些應用程序的每一個，給出它的名稱和版本號。2.3約定陳述一個程序員或一個系統(tǒng)分析員為了能使用此數(shù)據(jù)庫而需要了解的建立標號、標識的約定，例如用于標識數(shù)據(jù)庫的不同版本的約定和用于標識庫內(nèi)各個文卷、、記錄、數(shù)據(jù)項的命名約定等。2.4專門指導向準備從事此數(shù)據(jù)庫的生成、從事此數(shù)據(jù)庫的測試、維護人員提供專門的指導，例如將被送入數(shù)據(jù)庫的數(shù)據(jù)的格式和標準、送入數(shù)據(jù)庫的操作規(guī)程和步驟，用于產(chǎn)生、修改、更新或使用這些數(shù)據(jù)文卷的操作指導。如果這些指導的內(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è)計考慮。

數(shù)據(jù)要求說明書（GB856T——88）1引言1.1編寫目的說明編寫這份數(shù)據(jù)要求說明書的目的，指出預期的讀者。1.2背景說明：a.

待開發(fā)軟件系統(tǒng)的名稱；b.列出本項目的任務提出者、開發(fā)者、用戶以及將運行該項軟件的計算站（中心）或計算機網(wǎng)絡(luò)系統(tǒng)。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出有關(guān)的參考資料，如：a.

本項目的經(jīng)核準的計劃任務書或合同，上級機關(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ù)。進行描述時應把各數(shù)據(jù)元素邏輯地分成若干組，列如函數(shù)、源數(shù)據(jù)或?qū)τ谄鋺酶鼮榍‘數(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ù)采集工作的承擔者是用戶還是開發(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ì)如磁盤、磁帶、穿孔卡片等，均應具體說明；e.

數(shù)據(jù)值的范圍給出每一個數(shù)據(jù)元的合法值的范圍；f.

量綱給出數(shù)字的度量單位、增量的步長、零點的定標等。在數(shù)據(jù)是非數(shù)字量的情況下，要給出每一種合法值的形式和含意；g.

更新和處理的頻度給出預定的對輸入數(shù)據(jù)的更新和處理的頻度。如果數(shù)據(jù)的輸入是隨機的，應給出更新處理的頻度的平均值，或變化情況的某種其他度量。3.2輸人的承擔者說明預定的對數(shù)據(jù)輸入工作的承擔者。如果輸入數(shù)據(jù)同某一接口軟件有關(guān)，還應說明該接口軟件的來源。3.3預處理對數(shù)據(jù)的采集和預處理過程提出專門的規(guī)定，包括適合應用的數(shù)據(jù)格式、預定的數(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)等。文件給制實施規(guī)定的實例（GB8567-88）

盡管在文件編制中存在著很多靈活性，然而，文件的編制確實是非常必要的，其意義如前所述。為了控制這種靈活性，保證文件編制能達到應該達到的目的，對于具體的軟件開發(fā)任務，應編制的文件的種類、詳細程度應取決于承擔開發(fā)單位的管理能力、任務的規(guī)模、復雜性和成敗風險等因素。一個軟件開發(fā)單位應該根據(jù)本單位經(jīng)營承包的應用軟件的專業(yè)特點和本單位的管理能力，制定一個文件編制實施規(guī)定，說明在什么情況下應該編制哪些文件。由于國內(nèi)目前在這方面還缺乏成熟的經(jīng)驗，這里提供參考國外經(jīng)驗制定的兩個例子，用以向國內(nèi)軟件開發(fā)單位說明如何建立這種實施規(guī)定，使項目負責人能確定本項目開發(fā)過程中應編制的文件的種類。當然，例子畢竟只是例子，這兩個例子各自都不免有其片面性，它們兩者之間也不免有不一致之處，之所以列出來無非是供國內(nèi)軟件開發(fā)單位參考。例1：此例規(guī)定用求和法來確定應編制的文件。該方法的要點是提出十二個考慮因素來衡量一個應用軟，件，每個因素可能取值的范圍是互至5。任務負責人可用這十二個因素對所要開發(fā)的程序進行衡量，確定每個因素的具體值。把這十二個因素的值相加，得到一個總和。然后由這個總和的值來確定應該編制的文件的種類。使用這個方法的具體過程如下：a.

按表OI中的十二個因素衡量所要開發(fā)的程序，得到每個因素的值；b.

把衡量所得的各個因素的值相加，得總和之值；c.

根據(jù)總和之值，從表OZ查出應編制的文件的種類。表1文件編制的十二項衡量因素序號因素因素取值準則123451創(chuàng)造性要求沒有——在不同的設(shè)備上重編程序很少——具有嚴格的要求有限——具有新的接口相當多——應用現(xiàn)有的技巧重大的——應用先進的技巧2通用程度很強的限制——單一目標有限制——功能的范圍是參量化的有限的靈活性允許格式上有某些變化多用途，靈活的格式有一個主題領(lǐng)域很靈活——能在不同的設(shè)備上處理范圍廣泛的主題3工作范圍局部單位分指揮部單個指揮部多個指揮部國防部，世界范圍4目標范圍的變化沒有極少偶爾有經(jīng)常不斷5設(shè)備復雜性單機，常規(guī)處理單機，常規(guī)處理，擴充的外設(shè)系統(tǒng)多機，標準外設(shè)系統(tǒng)多機，復雜的外設(shè)系統(tǒng)主機控制系統(tǒng)，多機，自動I/O和顯示6人員1～2人3～5人5～10人10～18人18人以上7開發(fā)投資6人月以下6人月至3人年3人年至10人年10人年至30人年30人年以上8重要程度數(shù)據(jù)處理常規(guī)過程控制人身安全單位成敗國家安全9對程序改變的完成時間要求2周以上1～2周3～7天1～3天24小時以內(nèi)10對數(shù)據(jù)輸入的響應時間要求2周以上1～2周1～7天1～24小時60分鐘內(nèi)11程序語言高級語言高級語言帶一些匯編高級語言帶相當多的匯編匯編語言機器語言12并行的軟件開發(fā)沒有有限中等程度很多完全的并行開發(fā)表1文件編制的十二項衡量因素因素總和可行性研究報告項目開發(fā)計劃軟件需求說明書數(shù)據(jù)要求說明書概要設(shè)計說明書詳細設(shè)計說明書數(shù)據(jù)庫設(shè)計說明書用戶手冊（使用說明）操作手冊模塊開發(fā)卷宗測試設(shè)計測試分析報告項目開發(fā)總結(jié)報告開發(fā)制度月報12～18*14～2424～3838～5048～60

√√√√√√√√

√√√√

************

√√

√

************√√√√√

√√√

√√√√

√√√√

****√√√√√√√

√√√√*在因素總和較低的情況下,項目開發(fā)總結(jié)報告的內(nèi)容應包括：程序的主要功能、基本流程、測試結(jié)果和使用說明。**測試分析報告應該寫，但不必很正規(guī)。***數(shù)據(jù)要求說明和數(shù)據(jù)庫設(shè)計說明是否需要編寫應根據(jù)所開發(fā)軟件的實際需要來決定。例2：為了避免在軟件開發(fā)中文件編制的不足或過分，一個簡便的辦法是把對軟件文件的編制要求同軟件的規(guī)模大小聯(lián)系起來，這就是本例的出發(fā)點。軟件的規(guī)模不妨分為四級：1.

小規(guī)模軟件源程序行數(shù)小于5000的軟件；2.

中規(guī)模軟件源程序行數(shù)為10000～50000的軟件；3.

大規(guī)模軟件源程序行數(shù)為100000—500000的軟件；4.

特大規(guī)模軟件源程序行數(shù)大于500000的軟件。對上述的四級軟件的文件編制要求分別列于表3。至于源程序行數(shù)為5000～10000，50000～100000的軟件，其文件編制要求介于兩級之間，可根據(jù)一個軟件產(chǎn)品的具體情況，由項目負責人參照表3的規(guī)定，確定需要編制的文件種類。對于源程序行數(shù)大于500000的特大規(guī)模軟件，可進一步把本指南規(guī)定的十四種文件按實際需要擴展成更多種類。

詳細設(shè)計說明書（GB8567——88）

詳細設(shè)計說明書（GB8567——88）1引言1.1編寫目的說明編寫這份詳細設(shè)計說明書的目的，指出預期的讀者。1.2背景說明：a．

待開發(fā)軟件系統(tǒng)的名稱；b．

本項目的任務提出者、開發(fā)者、用戶和運行該程序系統(tǒng)的計算中心。1.3定義列出本文件中用到專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出有關(guān)的參考資料，如：a．

本項目的經(jīng)核準的計劃任務書或合同、上級機關(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)容往往與它所隸屬的上一層模塊的對應條目的內(nèi)容相同，在這種情況下，只要簡單地說明這一點即可。3.1程序描述給出對該程序的簡要描述，主要說明安排設(shè)計本程序的目的意義，并且，還要說明本程序的特點（如是常駐內(nèi)存還是非常駐？是否子程序？是可重人的還是不可重人的？有無覆蓋要求？是順序處理還是并發(fā)處理等）。3.2功能說明該程序應具有的功能，可采用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．

對各變量的功能、范圍、缺省條件等所加的注釋；d．

對使用的邏輯所加的注釋等等。3.11限制條件說明本程序運行中所受到的限制條件。3.12測試計劃說明對本程序進行單體測試的計劃，包括對測試的技術(shù)要求、輸入數(shù)據(jù)、預期結(jié)果、進度安排、人員職責、設(shè)備條件驅(qū)動程序及樁模塊等的規(guī)定。3.13尚未解決的問題說明在本程序的設(shè)計中尚未解決而設(shè)計者認為在軟件完成之前應解決的問題。4程序2（標識符）設(shè)計說明項目開發(fā)計劃（GB856T——88）1、引言1.1編寫目的說明：編寫這份軟件項目開發(fā)計劃的目的，并指出預期的讀者。1.2

背景

說明：a.

待開發(fā)的軟件系統(tǒng)的名稱；b.

本項目的任務提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機網(wǎng)絡(luò)；c.

該軟件系統(tǒng)同其他系統(tǒng)或其他機構(gòu)的基本的相互來往關(guān)系。1.3定義

列出本文件中用到的專門術(shù)語的定義和外文的首字母組詞的原詞組。1.4參考資料

列出用得著的參考資料，如：a.

本項目的經(jīng)核準的計劃任務書和合同、上級機關(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服務

列出需向用戶提供的各項服務，如培訓安裝、維護和運行支持等，應逐項規(guī)定開始日期、所提供支持的級別和服務的期限。2.3.4非移交的產(chǎn)品

說明開發(fā)集體應向本單位交出但不必向用戶移交的產(chǎn)品（文件甚至某些程序）。2.4驗收標準

對于上述這些應交出的產(chǎn)品和服務，逐項說明或引用資料說明驗收標準。2.5完成項目的最遲期限2.6本計劃的批準者和批準日期3實施計劃3.1工作任務的分解與人員分工

對于項目開發(fā)中需要完成的各項工作，從需求分析、設(shè)計、實現(xiàn)、測試直到維護，包括文件的編制、審批、打印、分發(fā)工作，用戶培訓工作，軟件安裝工作等，按層次進行分解，指明每項任務的負責人和參加人員。3.2說明負責接口工作的人員及他們的職責，包括：a.負責本項目同用戶的接口人員；b.

本項目同本單位各管理機構(gòu)，如合同計劃管理部門、財務部門、質(zhì)量管理部門等的接口人員；c.

負責本項目同個份合同負責單位的接口人員等。3.3進度

對于需求分析、設(shè)計、編碼實現(xiàn)、測試、移交、培訓和安裝等工作，給出每項工作任務的預定開始日期、完成日期及所需資源，規(guī)定各項工作任務完成的先后順序以及表征每項工作任務完成的標志性事件（即所謂“里程碑）。3.4預算

逐項列出本開發(fā)項目所需要的勞務（包括人員的數(shù)量和時間）以及經(jīng)費的預算（包括辦公費、差旅費、機時費、資料費、通訊設(shè)備和專用設(shè)備的租金等）和來源。3.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專題計劃要點

說明本項目開發(fā)中需制定的各個專題計劃（如分合同計劃、開發(fā)人員培訓計劃、測試計劃、安全保密計劃、質(zhì)量保證計劃、配置管理計劃、用戶培訓計劃、系統(tǒng)安裝計劃等）的要點。用類似F．3的方式，說明第2個程序乃至第N個程序的設(shè)計考慮。

項目開發(fā)總結(jié)報告（GB8567——88）1引言1.1編寫目的說明編寫這份項目開發(fā)總結(jié)報告的目的，指出預期的閱讀范圍。1.2背景說明：a．

本項目的名稱和所開發(fā)出來的軟件系統(tǒng)的名稱；b．

此軟件的任務提出者、開發(fā)者、用戶及安裝此軟件的計算中心。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出要用到的參考資料，如：a．

本項目的已核準的計劃任務書或合同、上級機關(guān)的批文；b．

屬于本項目的其他已發(fā)表的文件；c．

本文件中各處所引用的文件、資料，包括所要用到的軟件開發(fā)標準。列出這些文件的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2實際開發(fā)結(jié)果2.1產(chǎn)品說明最終制成的產(chǎn)品，包括：a．

程序系統(tǒng)中各個程序的名字，它們之間的層次關(guān)系，以千字節(jié)為單位的各個程序的程序量、存儲媒體的形式和數(shù)量；b．

程序系統(tǒng)共有哪幾個版本，各自的版本號及它們之間的區(qū)別；c．

每個文件的名稱；d．

所建立的每個數(shù)據(jù)庫。如果開發(fā)中制訂過配置管理計劃，要同這個計劃相比較。2.2主要功能和性能逐項列出本軟件產(chǎn)品所實際具有的主要功能和性能，對照可行性研究報告、項目開發(fā)計劃、功能需求說明書的有關(guān)內(nèi)容，說明原定的開發(fā)目標是達到了、未完全達到、或超過了。2.3基本流程用圖給出本程序系統(tǒng)的實際的基本的處理流程。2.4進度列出原定計劃進度與實際進度的對比，明確說明，實際進度是提前了、還是延遲了，分析主要原因。2.5費用列出原定計劃費用與實際支出費用的對比，包括：a.

工時，以人月為單位，并按不同級別統(tǒng)計；b.

計算機的使用時間，區(qū)別CPU時間及其他設(shè)備時間；c.

物料消耗、出差費等其他支出。明確說明，經(jīng)費是超出了、還是節(jié)余了，分析其主要原因。3開發(fā)工作評價3.1對生產(chǎn)效率的評價給出實際生產(chǎn)效率，包括：a．

程序的平均生產(chǎn)效率，即每人月生產(chǎn)的行數(shù)；b．

文件的平均生產(chǎn)效率，即每人月生產(chǎn)的千字數(shù)；并列出原訂計劃數(shù)作為對比。3.2對產(chǎn)品質(zhì)量的評價說明在測試中檢查出來的程序編制中的錯誤發(fā)生率，即每干條指令（或語句）中的錯誤指令數(shù)（或語句數(shù)）。如果開發(fā)中制訂過質(zhì)量保證計劃或配置管理計劃，要同這些計劃相比較。3.3對技術(shù)方法的評價給出對在開發(fā)中所使用的技術(shù)、方法、工具、手段的評價。3.4出錯原因的分析給出對于開發(fā)中出現(xiàn)的錯誤的原因分析。4經(jīng)驗與教訓列出從這項開發(fā)工作中所得到的最主要的經(jīng)驗與教訓及對今后的項目開發(fā)工作的建......用戶手冊（GB8567——88）1引言1.1編寫目的說明編寫這份用戶手冊的目的，指出預期的讀者。1.2背景說明：a.

這份用戶手冊所描述的軟件系統(tǒng)的名稱；b.

該軟件項目的任務提出者、開發(fā)者、用戶（或首批用戶）及安裝此軟件的計算中心。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出有用的參考資料，如：a.

項目的經(jīng)核準的計劃任務書或合同、上級機關(guān)的批文；b.

屬于本項目的其他已發(fā)表文件；c.

本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件資料的來源。2用途2.1功能結(jié)合本軟件的開發(fā)目的逐項地說明本軟件所具有各項功能以及它們的極限范圍。2.2性能2.2.1精度逐項說明對各項輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達到的精度，包括傳輸中的精度要求。2.2.2時間特性定量地說明本軟件的時間特性，如響應時間，更新處理時間，數(shù)據(jù)傳輸、轉(zhuǎn)換時間，計算時間等。2.2.3靈活性說明本軟件所具有的靈活性，即當用戶需求（如對操作方式、運行環(huán)境、結(jié)果精度、時間特性等的要求）有某些變化時，本軟件的適應能力。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)對這些命令的反應與答復。表征安裝工作完成的測試實例等。如果有的話，還應說明安裝過程中所需用到的專用軟件。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ù)合理性的檢驗以及當輸入數(shù)據(jù)有錯誤時應采取的措施，如建立出錯情況的記錄等；g.

支配——例如如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。4.2.2輸入格式說明對初始輸入數(shù)據(jù)和參量的格式要求，包括語法規(guī)則和有關(guān)約定，如：a.

長度—一例如字符數(shù)／行，字符數(shù)／項；b.

格式基準——例如以左