附錄計算機軟件開發(fā)文檔編寫指南 (1)(共14頁)

1、PAGE 10PAGE 25附錄計算機軟件開發(fā)文檔編寫(binxi)指南為使讀者具體了解怎樣編寫文檔，這里列出了十三種文檔的內(nèi)容要求及其簡要說明。這些文檔包括：可行性研究報告，項目開發(fā)計劃,需求規(guī)格說明書，概要設(shè)計說明書，詳細(xì)設(shè)計說明書，用戶操作手冊，測試計劃，測試報告，開發(fā)進度月報，項目開發(fā)總結(jié)報告，程序維護手冊，軟件(run jin)問題報告和軟件修改報告。各文檔內(nèi)容大綱由帶編好的標(biāo)題構(gòu)成，標(biāo)題后方括號內(nèi)為其說明。這里給出一個統(tǒng)一的封面格式：文檔編號(bin ho)：版 本 號：文檔名稱：項目名稱：項目負(fù)責(zé)人：編寫：年月日校對：年月日審核：年月日批準(zhǔn)：年月日開發(fā)單位：可行性研究報告引言1.

2、1編寫目的【闡明編寫可行性研究報告的目的，指出讀者對象?！?.2項目背景【應(yīng)包括：a.所建議開發(fā)軟件的名稱；b.項目的任務(wù)提出者、開發(fā)者、用戶即實現(xiàn)軟件的單位；c.項目于其它軟件或其他系統(tǒng)的關(guān)系。】1.3定義【列出文檔中用到的專門術(shù)語的定義和縮寫詞的原文】1.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：a.項目經(jīng)核準(zhǔn)的計劃任務(wù)、合同或上級機關(guān)的批文；b.與項目有關(guān)的已發(fā)表的資料；c.文檔中所引用的資料，所采用的軟件標(biāo)準(zhǔn)或規(guī)范?！靠尚行匝芯康那疤?.1要求【類出兵說明建議開發(fā)軟件的基本要求，如a.功能；b.性能；c.輸出；d.輸入；e.基本的數(shù)據(jù)流程和處理流

3、程；f.安全與保密要求；g.與軟件相關(guān)的其他系統(tǒng)；h.完成期限?！?.2目標(biāo)【可包括：a.人力與設(shè)備費用的節(jié)省；b.處理速度的提高；c.控制精度或生產(chǎn)能力的提高；d.管理信息服務(wù)(fw)的改進；e.策略系統(tǒng)的改進；f.人員工作效率的提高，等等?！?.3條件、假定和限制【可包括：a.建議開發(fā)軟件運行的最短壽命；b.進行系統(tǒng)方案選擇比較的期限；c.經(jīng)費(jngfi)來源和使用限制；d.法律和政策方面的限制；e.硬件、軟件、運行環(huán)境和開發(fā)環(huán)境的條件和限制；f.可利用的信息和資源；g.建議開發(fā)軟件投入使用的最遲時間?！?.4可行性研究方法(fngf)2.5決定可行性的主要因素對現(xiàn)有系統(tǒng)的分析3.1處理

4、流程和數(shù)據(jù)流程3.2工作負(fù)荷3.3費用支出【如人力、設(shè)備、空間、支持性服務(wù)、材料等項開支。】3.4人員【列出所需人員的專業(yè)技術(shù)類別和數(shù)量。】3.5設(shè)備3.6局限性【說明現(xiàn)有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng)?！克ㄗh技術(shù)可行性分析4.1對系統(tǒng)的簡要描述4.2處理流程和數(shù)據(jù)流程4.3與現(xiàn)有系統(tǒng)比較的優(yōu)越性4.4采用建議系統(tǒng)可能帶來的影響4.4.1對設(shè)備的影響4.4.2對現(xiàn)有軟件的影響4.4.3對用戶的影響4.4.4對系統(tǒng)運行的影響4.4.5對開發(fā)環(huán)境的影響4.4.6對運行環(huán)境的影響4.4.7對經(jīng)費支出的影響4.5技術(shù)可行性評價【包括：a.在限制條件下，功能目標(biāo)是否能達到；b.利用現(xiàn)有技術(shù)，

5、功能目標(biāo)能否達到；c.對開發(fā)人員數(shù)據(jù)和質(zhì)量的要求，并說明能否滿足；d.在規(guī)定的期限內(nèi)，開發(fā)能否完成?！克ㄗh系統(tǒng)經(jīng)濟可行性分析5.1支出5.1.1基建投資5.1.2其它一次性支出5.1.3經(jīng)常性支出5.2效益5.2.1一次性收益5.2.2經(jīng)常性收益5.2.3不可定量收益5.3收益/投資比5.4投資回收周期5.5敏感性分析(fnx)【敏感性分析是指一些關(guān)鍵性因素，如：系統(tǒng)生存周期長短、系統(tǒng)工作負(fù)荷量、處理速度要求(yoqi)、設(shè)備和軟件配置變化對支出和效益的影響等的分析。】社會(shhu)因素可行性分析6.1法律因素【如，合同責(zé)任、侵犯專利權(quán)、侵犯版權(quán)等問題的分析?！?.2用戶使用可行性【如，用

6、戶單位的行政管理、工作制度、人員素質(zhì)等能否滿足要求?！科渌晒┻x擇的方案【逐個闡明其它可供選擇的方案，并重點說明未被推薦的理由?！拷Y(jié)論意見【結(jié)論意見可能是：a.可著手組織開發(fā)；b.須待若干條件（如資金、人力、設(shè)備等）具備后才能開發(fā)；c.需對開發(fā)不表進行某些修改；d.不能進行或不必進行（如技術(shù)不成熟，經(jīng)濟上不合算）；e.其它?！宽椖块_發(fā)計劃引言1.1編寫目的【闡明編寫開發(fā)計劃的目的，指出讀者對象。】1.2項目背景【可包括：a.項目的委托單位、開發(fā)單位和主管部門；b.該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系?！?.3定義【列出本檔中用到的專門術(shù)語的定義和縮寫詞的原文?！?.4參考資料【可包括：a.項目經(jīng)核準(zhǔn)的計

7、劃任務(wù)書、合同或上級機關(guān)的批文；b.文檔所引用的資料、規(guī)范等；列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源?！宽椖扛攀?.1工作內(nèi)容【簡要說明項目的各項主要工作，介紹所開發(fā)軟件的功能、性能等。若不編寫可行性研究報告，則應(yīng)在本節(jié)給出較詳細(xì)的介紹】2.2條件與限制【闡明為完成項目應(yīng)具備的條件、開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件。必要時還應(yīng)說明用戶及分合同承包者承擔(dān)的工作、完成期限及其他條件與限制。】2.3產(chǎn)品2.3.1程序【列出應(yīng)交付的程序名稱、使用的語言及存儲形式】2.3.2文檔【列出應(yīng)交付的文檔?！?.4運行環(huán)境【應(yīng)包括硬件環(huán)境、軟件環(huán)境。】2.5服務(wù)【闡明開發(fā)單位可向用戶

8、提供的服務(wù)。如人員培訓(xùn)、安裝、保修、維護和其他運行支持?！?.6驗收標(biāo)準(zhǔn)實施計劃3.1任務(wù)分解【任務(wù)的劃分及各項任務(wù)的負(fù)責(zé)人?！?.2進度【按階段完成的項目，用圖表說明開始時間、完成時間?！?.3預(yù)算3.4關(guān)鍵問題【說明可能影響項目的關(guān)鍵問題，如設(shè)備條件、技術(shù)難點或其他風(fēng)險因素，并說明對策?！咳藛T組織及分工交付(jiof)期限專題計劃(jhu)要點【如測試計劃、質(zhì)量保證計劃、配置管理計劃、人員培訓(xùn)計劃、系統(tǒng)(xtng)安裝計劃等?！啃枨笠?guī)格說明書引言1.1編寫目的【闡明編寫需求說明書的目的，指明讀者對象?！?.2項目背景【應(yīng)包括：a.項目的委托單位、開發(fā)單位和主管部門；b.該軟件系統(tǒng)與其他系統(tǒng)

9、的關(guān)系。】1.3定義【列出文檔中所用到的專門術(shù)語的定義和縮寫詞的原文?！?.4參考資料【可包括：a.項目經(jīng)核準(zhǔn)的計劃任務(wù)書、合同或上級機關(guān)的批文；b.該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系；c.文檔所引用的資料、標(biāo)準(zhǔn)和規(guī)范。列出這些資料的作者、標(biāo)準(zhǔn)、編號、發(fā)表日期、出版單位或資料來源?！咳蝿?wù)概述2.1目標(biāo)2.2運行環(huán)境2.3條件與限制數(shù)據(jù)描述3.1靜態(tài)數(shù)據(jù)3.2動態(tài)數(shù)據(jù)【包括輸入數(shù)據(jù)和輸出數(shù)據(jù)?！?.3數(shù)據(jù)庫描述【給出使用數(shù)據(jù)庫的名稱和類型?！?.4數(shù)據(jù)詞典3.5數(shù)據(jù)采集功能需求4.1功能劃分4.2功能描述性能需求5.1數(shù)據(jù)精確度5.2時間特性【如響應(yīng)時間、更新處理時間、數(shù)據(jù)轉(zhuǎn)換與傳輸時間、運行時間等?！?/p>

10、5.3適應(yīng)性【在操作方式、運行環(huán)境、與其他軟件的借口以及開發(fā)計劃等發(fā)生變化時，應(yīng)具有的適應(yīng)能力?！窟\行需求6.1用戶界面【如屏幕格式、報表格式、菜單格式、輸入輸出時間等。】6.2硬件接口6.3軟件接口6.4故障處理其他需求【如可使用性、安全保密、可維護性、可移植性等?！扛乓O(shè)計說明書引言1.1編寫(binxi)目的【闡明編寫概要設(shè)計說明書的目的，指明讀者(dzh)對象?！?.2項目背景【應(yīng)包括：a.項目的委托單位、開發(fā)(kif)單位和主管部門；b.該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系?！?.3定義【列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的原意?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日

11、期、出版單位或資料來源，可包括：a.項目經(jīng)核準(zhǔn)的計劃任務(wù)書、合同或上級機關(guān)的批文；b.項目開發(fā)計劃；c.需求規(guī)格說明書；d.測試計劃（初稿）；e.用戶操作手冊（初稿）；f.文檔所引用的資料、采用的標(biāo)準(zhǔn)或規(guī)范?！咳蝿?wù)概述2.1目標(biāo)2.2運行環(huán)境2.3需求概述2.4條件與限制總體設(shè)計3.1處理流程3.2總體結(jié)構(gòu)和模塊外部設(shè)計3.3功能分配【表明各項功能與程序結(jié)構(gòu)的關(guān)系】接口設(shè)計4.1外部接口【包括用戶界面、軟件接口與硬件接口?！?.2內(nèi)部接口【模塊之間的接口】數(shù)據(jù)結(jié)構(gòu)設(shè)計5.1邏輯結(jié)構(gòu)設(shè)計5.2物理結(jié)構(gòu)設(shè)計5.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系運行設(shè)計6.1運行模塊的組合6.2運行控制6.3運行時間出錯處理設(shè)

12、計7.1出錯輸出信息7.2出錯處理對策【如設(shè)之后備、性能降級、恢復(fù)及再啟動等?！堪踩Ｃ茉O(shè)計維護設(shè)計【說明為方便維護工作的設(shè)施，如維護模塊等?！吭敿?xì)設(shè)計說明書引言1.1編寫目的【闡明編寫詳細(xì)設(shè)計說明書的目的，指明讀者對象?！?.2【應(yīng)包括項目的來源和主管部門等?！?.3定義【列出文檔中所用的專門術(shù)語的定義和縮寫詞的原意?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：a.項目的計劃任務(wù)書、合同或批文；b.項目開發(fā)計劃；c.需求規(guī)格說明書；d.概要設(shè)計說明書；e.測試計劃（初稿）；f.用戶操作手冊（初稿）；g.文檔所引用的其他資料、軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范?！靠?/p>

13、體設(shè)計2.1需求(xqi)概述2.2軟件結(jié)構(gòu)【如給出軟件系統(tǒng)的結(jié)構(gòu)圖。】程序(chngx)描述【逐個(zhg)模塊給出以下的說明：】3.1功能3.2性能3.3輸入項目3.4輸出項目3.5算法【模塊所選用的算法?！?.6程序邏輯【詳細(xì)描述模塊實現(xiàn)的算法，可采用；a.標(biāo)準(zhǔn)流程圖；b.PDL語言；c.N-S圖；d.PAD；e.判定表等描述算法的圖表。】3.7接口3.8存儲分配3.9限制條件3.10測試要點【給出測試模塊的主要測試要求?！坑脩舨僮魇謨?、引言1.1編寫目的【闡明編寫手冊的目的，指明讀者對象。】1.2項目背景【說明項目來源、委托單位、開發(fā)單位及主管部門?！?.3定義【列出手冊中使用的專門

14、術(shù)語的定義和縮寫詞的原意?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：a.項目的計劃任務(wù)書、合同或批文；b.項目開發(fā)計劃；c.需求規(guī)格說明書；d.概要設(shè)計說明書；e.詳細(xì)設(shè)計說明書；f.測試計劃；g.手冊中引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范?！寇浖攀?.1目標(biāo)2.2功能2.3性能a.數(shù)據(jù)精確度【包括輸入、輸出及處理數(shù)據(jù)的精度。】b.時間特性【如響應(yīng)時間、處理時間、數(shù)據(jù)傳輸時間等?！縞.靈活性【在操作方式、運行環(huán)境需作某些變更時軟件的適應(yīng)能力?！窟\行環(huán)境3.1硬件【列出軟件系統(tǒng)運行時所的硬件最小配置，如a.計算機型號、主存容量；b.外存

15、儲器、媒體、記錄格式、設(shè)備型號及數(shù)量；c.輸入、輸出設(shè)備；d.數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號及數(shù)量?！?.2支持軟件【如：a.操作系統(tǒng)名稱及版本號；b.語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號；c.數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號；d.其他必要的支持軟件?！渴褂谜f明4.1安裝和初始化【給出程序的存儲形式、操作命令、反饋信息及其含義、表明安裝完成的測試實例以及安裝所需的軟件工具等】4.2輸入【給出輸入數(shù)據(jù)(shj)或參數(shù)的要求?！?.2.1數(shù)據(jù)背景【說明(shumng)數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制和質(zhì)量管理等?！?.2.2數(shù)據(jù)格式(g shi)【如：a.長度；b.格式基準(zhǔn)；c.標(biāo)號；d.順序；e

16、.分隔符；f.詞匯表；g.省略和重復(fù)；h.控制?！?.3輸出【給出每項輸出數(shù)據(jù)的說明?！?.3.1數(shù)據(jù)背景【說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等?！?.3.2數(shù)據(jù)格式【詳細(xì)闡明美儀輸出數(shù)據(jù)的格式，如：首部、主體和尾部的具體形式?！?.3.3舉例4.4出錯和恢復(fù)【給出：a.出錯信息及其含意；b.用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動。】4.5求助查詢【說明如何操作】運行說明5.1運行表【列出每種可能的運行情況，說明其運行目的。】5.2運行步驟【按順序說明每種運行的步驟，應(yīng)包括：】5.2.1運行控制5.2.2操作子信息a.運行目的；b.操作要求；c.啟動方法；d.預(yù)計運行時間；e.操

17、作命令格式及說明；f.其他事項。5.2.3輸入/輸出文件【給出建立或更新文件的有關(guān)信息，如：】a.文件的名稱及編號；b.記錄媒體；c.存留的目錄；d.文件的支配【說明確定保留文件或廢棄文件的準(zhǔn)側(cè)，分發(fā)文件的對象，占用硬件的優(yōu)先級及保密控制等?！?.2.4啟動或恢復(fù)過程非常規(guī)過程【提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯處理操作、向后備系統(tǒng)切換操作以及維護人員須知的操作和注意事項?！?、操作命令一覽表【按字母順序逐個列出全部操作命令的格式、功能及參數(shù)說明?！砍绦蛭募ɑ蛎钗募┖蛿?shù)據(jù)文件一覽表【按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標(biāo)識符及說明?！坑脩舨僮髋e例測試計劃

18、引言1.1編寫目的【闡明編寫測試計劃的目的并指明讀者對象?！?.2項目背景【說明項目的來源、委托單位及主管部門?！?.3定義【列出測試計劃中所用到的專門術(shù)語的定義和縮寫詞的原意?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期(rq)、出版單位或資料來源，可包括：a.項目的計劃任務(wù)書、合同或批文；b.項目開發(fā)計劃；c.需求規(guī)格說明書；d.概要設(shè)計說明書；e.詳細(xì)設(shè)計說明書；f.用戶操作手冊；g.本測試計劃中引用的其他資料、采用的軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范?！咳蝿?wù)(rn wu)概論2.1目標(biāo)(mbio)2.2運行環(huán)境2.3需求概述2.4條件與限制計劃3.1測試方案【說明確定測試方法和選取測試用

19、例的原則。】3.2測試項目【列出組裝測試和確認(rèn)測試中每一項測試的內(nèi)容、名稱、目的和進度?！?.3測試準(zhǔn)備3.4測試機構(gòu)及人員【測試機構(gòu)名稱、負(fù)責(zé)人和職責(zé)。】測試項目說明【按順序逐個對測試項目做出說明：】4.1測試項目名稱及測試內(nèi)容4.2測試用例4.2.1輸入【輸入的數(shù)據(jù)和輸入命令?！?.2.2輸出【預(yù)期的輸出數(shù)據(jù)?！?.2.3步驟及操作4.2.4允許偏差【給出實測結(jié)果與預(yù)期結(jié)果之間允許偏差的范圍?！?.3進度4.4條件【給出項目測試對資源的特殊要求，如設(shè)備、軟件、人員等?！?.5測試資料【說明項測試所需的資料?！吭u價5.1范圍【說明所完成的各項測試說明問題的范圍及其局限性?！?.2準(zhǔn)側(cè)【說明評

20、價測試結(jié)果的準(zhǔn)則?！繙y試分析報告引言1.1編寫目的【闡明編寫測試分析報告的目的并指明讀者對象?！?.2項目背景【說明項目的來源、委托單位及主管部門。】1.3定義【列出測試分析報告中用到的專門術(shù)語的定義和縮寫詞的原意?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：a.項目的計劃任務(wù)書、合同或批文；b.項目開發(fā)計劃；c.需求規(guī)格說明書；d.概要設(shè)計說明書；e.詳細(xì)設(shè)計說明書；f.用戶操作手冊；g.測試計劃；h.測試分析所引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。】2、測試計劃執(zhí)行(zhxng)情況2.1測試項目【列出每一測試項目的名稱(mngchn

21、g)、內(nèi)容和目的?！?.2測試機構(gòu)和人員【給出測試機構(gòu)名稱、負(fù)責(zé)人和參與(cny)測試員名單?！?.3測試結(jié)果【按順序給出每一測試項目的：a.實測結(jié)果數(shù)據(jù)；b.與預(yù)期結(jié)果數(shù)據(jù)的偏差；c.該項測試表明的事實；d.該項測試發(fā)現(xiàn)的問題?！?、軟件需求測試結(jié)論【按順序給出每一項需求測試的結(jié)論。包括：a.證實的軟件能力；b.局限性（即項目需求未得到充分測試的情況及原因）?！?、評價4.1軟件能力【經(jīng)過測試所表明的軟件能力?！?.2缺陷和限制【說明測試所揭露的軟件缺陷和不足，以及可能給軟件運行帶來的影響?！?.3建議【提出為彌補上述缺陷的建議】4.4測試結(jié)論【說明能否通過】開發(fā)進度月報報告時間及所處的開發(fā)

22、階段工程進度2.1本月內(nèi)的主要活動2.2實際進展與計劃比較所用工時【按不同層次人員分別計時。】所用機時【按所用計算機機型分別計時?！拷?jīng)費支出【分類列出本月經(jīng)費支出項目，給出支出總額，并與計劃比較?！抗ぷ饔龅降膯栴}及采取的對策本月完成的成果下月的工作計劃特殊問題項目開發(fā)總結(jié)報告引言1.1編寫目的【闡明編寫總結(jié)報告的目的并指明讀者對象?！?.2項目背景【說明項目的來源、委托單位、開發(fā)單位及主管部門。】1.3定義【列出報告用到的專門術(shù)語的定義和縮寫詞的原意?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：a.項目經(jīng)核準(zhǔn)的計劃任務(wù)書、合同或上級機關(guān)的批文；b.項

23、目開發(fā)計劃；c.需求規(guī)格說明書；d.概要設(shè)計說明書；e.詳細(xì)設(shè)計說明書；f.用戶操作手冊；g.測試計劃；h.測試分析報告；i.本報告引用的其他資料、采用的開發(fā)標(biāo)準(zhǔn)或開發(fā)規(guī)范?！?、開發(fā)(kif)結(jié)果2.1產(chǎn)品(chnpn)【可包括：a.列出各部分的程序名稱、源程序行數(shù)（包括注釋行或目標(biāo)程序字節(jié)數(shù)及程序總計數(shù)量、存儲形式(xngsh)；b.產(chǎn)品文檔名稱等。】2.2主要功能及性能2.3所用工時【按人員的不同層次分別計時?！?.4所用機時【按所用計算機機型分別計時】2.5進度【給出計劃進度與實際進度的對比。】2.6費用3、評價3.1生產(chǎn)率評價【如平均每人每月生產(chǎn)的源程序行數(shù)、文檔的字?jǐn)?shù)等?！?.2技

24、術(shù)方案評價3.3產(chǎn)品質(zhì)量評價4、經(jīng)驗與教訓(xùn)程序維護手冊引言1.1編寫目的【闡明編寫手冊的目的并指明讀者對象?！?.2項目背景【說明項目的提出者、開發(fā)者、用戶和使用場所?！?.3定義【列出報告用到的專門術(shù)語的定義和縮寫詞的原意?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，以及保密級別，可包括：a.用戶手冊；b.與本項目有關(guān)的其他文檔?！肯到y(tǒng)說明2.1系統(tǒng)用途【說明系統(tǒng)具備的功能，輸入和輸出。】2.2安全保密【說明系統(tǒng)安全保密方面的考慮?！?.3總體說明【說明系統(tǒng)的總體功能，對系統(tǒng)、子系統(tǒng)和作業(yè)做出綜合性的介紹，并用圖表的方式給出系統(tǒng)主要部分的內(nèi)部關(guān)系?！?.4

25、程序說明【說明系統(tǒng)中每一程序、分程序的細(xì)節(jié)和特性?！?.4.1程序1的說明 2.4.1.1功能【說明程序的功能?！?2.4.1.2方法【說明實際方法。】 2.4.1.3輸入【說明程序的輸入、媒體、運行數(shù)據(jù)記錄、運行開始時使用的輸入數(shù)據(jù)的類型和存放單元、與程序初始化有關(guān)的入口要求。】 2.4.1.4處理【處理特點和目的，如a.用圖表說明程序的運行的邏輯流程；b.程序主要轉(zhuǎn)移條件；c.對程序的約束條件；d.程序結(jié)束時的出口要求；e.與下一個程序的通信與聯(lián)結(jié)（運行、控制）；f.由該程序產(chǎn)生并供處理程序段使用的輸出數(shù)據(jù)類型和存放單元；g.程序運行所用存儲量、類型及存儲位置等?！?.4.1.5輸出(sh

26、ch)【程序的輸出】2.4.1.6接口【本程序(chngx)與本系統(tǒng)其他部分的接口?！?.4.1.7表格【說明程序內(nèi)部的各種表、項的細(xì)節(jié)和特性。對每張表的說明至少包括：a.表的標(biāo)識符；b.使用目的；c.使用此表的其他程序；d.邏輯劃分，如塊或部，不包括表項；e.表的基本結(jié)構(gòu)；f.設(shè)計安排，包括標(biāo)的控制信息。表目結(jié)構(gòu)細(xì)節(jié)、使用中的特有性質(zhì)及各表項的標(biāo)志(biozh)、位置、用途、類型、編碼表示?！?.4.1.8特有的運行性質(zhì)【說明在用戶操作手冊中沒有提到的運行性質(zhì)。】2.4.2程序2的說明【與程序1的說明相同。以后其他各程序的說明相同?！坎僮鳝h(huán)境3.1設(shè)備【逐項說明系統(tǒng)的設(shè)備配置及其特性。】3.

27、2支持軟件【列出系統(tǒng)使用的支持軟件，包括它們的名稱和版本號。】3.3數(shù)據(jù)庫【說明每個數(shù)據(jù)庫的性質(zhì)和內(nèi)容，包括安全考慮。】 3.3.1總體特征【如：a.標(biāo)識符；b.使用這些數(shù)據(jù)庫的程序；c.靜態(tài)數(shù)據(jù)；d.動態(tài)數(shù)據(jù)；e.數(shù)據(jù)庫的存儲媒體；f.程序使用數(shù)據(jù)庫的限制?！?3.3.2結(jié)構(gòu)及詳細(xì)說明3.3.2.1說明該數(shù)據(jù)庫的結(jié)構(gòu)，包括其中的記錄和項；3.3.2.2說明記錄的組成，包括首部或控制段、記錄體；3.3.2.3說明每個記錄結(jié)構(gòu)的字段，包括：標(biāo)記或標(biāo)號、字段的字符長度和位數(shù)、該字段的允許值范圍。3.3.2.4擴充：說明為記錄追加字段的規(guī)定。維護過程4.1約定【列出該軟件系統(tǒng)設(shè)計中使用全部規(guī)則和約定

28、，包括：a.程序、分程序、記錄、字段和存儲區(qū)的標(biāo)識或標(biāo)號助記符的使用規(guī)則；b.圖表的處理標(biāo)準(zhǔn)、卡片的連續(xù)順序、語句和記號中使用的縮寫、出現(xiàn)在圖表中的符號名；c.使用的軟件技術(shù)標(biāo)準(zhǔn)；d.標(biāo)準(zhǔn)化的數(shù)據(jù)元素及其特征。】4.2驗證過程【說明一個程序段修改后，對其進行驗證的要求和過程（包括測試程序和數(shù)據(jù)）及程序周期性驗證的過程。】 4.3出錯及糾正方法【列出出錯狀態(tài)及其糾正方法。】4.4專門維護過程【說明文檔其他地方?jīng)]有提到的專門維護，如：a.維護該軟件系統(tǒng)的輸入輸出部分（如數(shù)據(jù)庫）的要求、過程和驗證方法；b.運行程序庫維護系統(tǒng)所不許的要求、過程和驗證方法；c.對閏年、世紀(jì)變更所需要的臨時性修改等?！?

29、.5專用維護(wih)程序【列出維護軟件系統(tǒng)使用的后備技術(shù)和專用程序（如文件恢復(fù)程序、淘汰過時文件的程序等）的目錄，并加以說明，內(nèi)容包括：a.維護作業(yè)的輸入輸出要求；b.輸入的詳細(xì)過程及在硬設(shè)備上建立、運行并完成維護作業(yè)的操作步驟。】4.6程序清單和流程圖【引用資料(zlio)或提供附錄給出程序清單和流程圖。】軟件(run jin)問題報告登記號【由軟件配置管理部門為該報告規(guī)定一個唯一的、順序的標(biāo)號。】登記日期【軟件配置管理部門登記該報告的日期?！繂栴}發(fā)現(xiàn)日期【發(fā)現(xiàn)該問題的日期和時間】活動【在哪個階段發(fā)現(xiàn)的問題，分為單元測試、組裝測試、確認(rèn)測試和運行維護?！繝顟B(tài)【在軟件配置記錄中維護的動態(tài)指示

30、，狀態(tài)表示有：a.正在復(fù)查“軟件問題報告”，以確定將采取什么行動；b.“軟件問題報告”已由指定的人去進行處理；c.修改已完成，并經(jīng)過測試，正準(zhǔn)備交給主程序庫；d.主程序庫已經(jīng)更新，主程序庫修改的重新測試尚未完成；e.做了重新測試，問題再現(xiàn)；f.做了重新測試，所做的修改無故障，“軟件問題報告”被關(guān)閉；g.留待以后關(guān)閉?！繄蟾嫒恕咎顚憽败浖栴}報告”人員的姓名、地址、電話?！繂栴}屬于什么方面【區(qū)分是程序的問題，還是模塊的問題，或是數(shù)據(jù)庫的問題，文件的問題。也可能是它們的某種組合?！磕K/子系統(tǒng)【出現(xiàn)的模塊明。如果不知是哪個模塊，可標(biāo)出子系統(tǒng)名，盡量給出細(xì)節(jié)?！啃薷陌姹咎枴境霈F(xiàn)問題的模塊版本?！看艓А景袉栴}的模塊的主程序庫的磁帶的標(biāo)識符?！繑?shù)據(jù)庫【當(dāng)發(fā)現(xiàn)問題時所使用