計(jì)算機(jī)軟件開發(fā)文檔編寫指南

1、計(jì)算機(jī)軟件開發(fā)文檔編寫指南一、項(xiàng)目開發(fā)計(jì)劃1引言11.1編寫目的11.2項(xiàng)目背景11.3定義21.4參考資料22項(xiàng)目概述22.1工作內(nèi)容22.2條件與限制22.3產(chǎn)品22.4運(yùn)行環(huán)境22.5服務(wù)32.6驗(yàn)收標(biāo)準(zhǔn)33. 實(shí)施計(jì)劃33.1任務(wù)分解33.2進(jìn)度33.3預(yù)算33.4關(guān)鍵問題34人員組織及分工35交付期限36.專題計(jì)劃要點(diǎn) 31引言1.1編寫目的【闡明編寫開發(fā)計(jì)劃的目的，指明讀者對象?！?.2項(xiàng)目背景【可包括：a. 項(xiàng)目的委托單位、開發(fā)單位和主管部門;b. 該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系?！?.3定義【列出本檔中用到的專門術(shù)語的定義和縮寫詞的原文?！?.4參考資料【可包括：a. 項(xiàng)目經(jīng)核準(zhǔn)的

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

3、發(fā)單位可向用戶提供的服務(wù)。如人員培訓(xùn)、安裝、保修、維護(hù)和其他運(yùn)行支持?！?.6驗(yàn)收標(biāo)準(zhǔn)3 實(shí)施計(jì)劃3.1任務(wù)分解【任務(wù)的劃分及各項(xiàng)任務(wù)的負(fù)責(zé)人?！?.2進(jìn)度【按階段完成的項(xiàng)目，用圖表說明開始時間、完成時間。】3.3預(yù)算3.4關(guān)鍵問題【說明可能影響項(xiàng)目的關(guān)鍵問題，如設(shè)備條件、技術(shù)焦點(diǎn)或其他風(fēng)險(xiǎn)因素，并說明對策?！?. 人員組織及分工5 交付期限6. 專題計(jì)劃要點(diǎn)【如測試計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、人員培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等。二、需求規(guī)格說明書1引言41.1編寫目的41.2項(xiàng)目背景51.3定義51.4參考資料52.任務(wù)概述52.1目標(biāo)52.2運(yùn)行環(huán)境52.3條件與限制53數(shù)據(jù)描述63.1靜

4、態(tài)數(shù)據(jù)63.2動態(tài)數(shù)據(jù)63.3數(shù)據(jù)庫介紹63.4數(shù)據(jù)詞典63.5數(shù)據(jù)采集64. 功能需求64.1功能劃分64.2功能描述65. 性能需求65.1數(shù)據(jù)精確度65.2時間特性65.3適應(yīng)性76運(yùn)行需求76.1用戶界面76.2硬件接口 76.3軟件接口 76.4故障處理77其它需求71 .引言1.1編寫目的【闡明編寫需求說明書的目的，指明讀者對象?！繛槊鞔_軟件需求、安排項(xiàng)目規(guī)劃與進(jìn)度、組織軟件開發(fā)與測試，撰寫本文檔。本文檔供項(xiàng)目經(jīng)理、設(shè)計(jì)人員、開發(fā)人員參考。1.2項(xiàng)目背景c. 項(xiàng)目的委托單位、開發(fā)單位和主管部門d. 該軟件系統(tǒng)與其他1.3定義【列出文當(dāng)中所用到的專門術(shù)語的定義和縮寫詞的原文?！?.4

5、參考資料c. 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文d. 項(xiàng)目開發(fā)計(jì)劃e. 文檔所引用的資料、標(biāo)準(zhǔn)和規(guī)范。列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版 單位或資料來源2 任務(wù)概述2.1目標(biāo)2.2運(yùn)行環(huán)境操作系統(tǒng)： 支持環(huán)境： 數(shù)據(jù)庫:Microsoft Win dows 2000 Adva need ServerIIS 5.0Microsoft SQL Server 20002.3條件與限制3 數(shù)據(jù)描述3.1靜態(tài)數(shù)據(jù)3.2動態(tài)數(shù)據(jù)【包括輸入數(shù)據(jù)和輸出數(shù)據(jù)?！?.3數(shù)據(jù)庫介紹【給出使用數(shù)據(jù)庫的名稱和類型。】3.4數(shù)據(jù)詞典3.5數(shù)據(jù)采集4. 功能需求4.1功能劃分4.2功能描述5. 性能需

6、求5.1數(shù)據(jù)精確度5.2時間特性【如響應(yīng)時間、更新處理時間、數(shù)據(jù)轉(zhuǎn)換與傳輸時間、運(yùn)行時間等。5.3適應(yīng)性【在操作方式、運(yùn)行環(huán)境、與其它軟件的接口以及開發(fā)計(jì)劃等發(fā)生變化時，應(yīng)具有的適應(yīng)能力。】6 運(yùn)行需求6.1用戶界面【如屏幕格式、報(bào)表格式、菜單格式、輸入輸出時間等?！?.2硬件接口6.3軟件接口6.4故障處理7 其它需求【如可使用性、安全保密、可維護(hù)性、可移植性等。】三、概要設(shè)計(jì)說明書1引言81.1編寫目的81.2項(xiàng)目背景81.3定義81.4參考資料92 任務(wù)概述92.1目標(biāo)92.2運(yùn)行環(huán)境92.3需求概述92.4條件與限制93 總體設(shè)計(jì)93.1處理流程93.2總體結(jié)構(gòu)和模塊外部設(shè)計(jì) 93.3

7、功能分配94. 接口設(shè)計(jì)104.1外部接口 104.2內(nèi)部接口 105. 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 115.1邏輯結(jié)構(gòu)設(shè)計(jì)115.2物理結(jié)構(gòu)設(shè)計(jì) 115.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 116. 運(yùn)行設(shè)計(jì)116.1運(yùn)行模塊的組合 116.2運(yùn)行控制116.3運(yùn)行時間117. 出錯處理設(shè)計(jì)117.1出錯輸出信息117.2出錯處理對策 118. 安全保密設(shè)計(jì)119. 維護(hù)設(shè)計(jì)111 .引言1.1編寫目的【闡明編寫概要設(shè)計(jì)說明書的目的，指明讀者對象?！?.2項(xiàng)目背景【應(yīng)包括：e. 項(xiàng)目的委托單位、開發(fā)單位和主管部門；f. 該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系?！?.3定義【列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的原文。1.4

8、參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括:f. 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文；g. 項(xiàng)目開發(fā)計(jì)劃；h. 需求規(guī)格說明書；i. 測試計(jì)劃（初稿）；j. 用戶操作手冊（初稿）；k. 文檔所引用的資料、采用的標(biāo)準(zhǔn)或規(guī)范。】2 任務(wù)概述2.1目標(biāo)2.2運(yùn)行環(huán)境2.3需求概述2.4條件與限制3. 總體設(shè)計(jì)3.1處理流程3.2總體結(jié)構(gòu)和模塊外部設(shè)計(jì)3.3功能分配【表明各項(xiàng)功能與程序結(jié)構(gòu)的關(guān)系。】4接口設(shè)計(jì)4.1外部接口【包括用戶界面、軟件接口與硬件接口?！?.2內(nèi)部接口【模塊之間的接口。】計(jì)算機(jī)軟件開發(fā)文檔編寫指南5. 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)5.1邏輯結(jié)構(gòu)設(shè)計(jì)5

9、.2物理結(jié)構(gòu)設(shè)計(jì)5.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系6. 運(yùn)行設(shè)計(jì)6.1運(yùn)行模塊的組合6.2運(yùn)行控制6.3運(yùn)行時間7. 出錯處理設(shè)計(jì)7.1出錯輸出信息7.2出錯處理對策【如設(shè)置后備、性能降級、恢復(fù)及再啟動等?！?. 安全保密設(shè)計(jì)9. 維護(hù)設(shè)計(jì)【說明為方便維護(hù)工作的設(shè)施，如維護(hù)模塊等。四、詳細(xì)設(shè)計(jì)說明書1引言121. 1編寫目的121.2項(xiàng)目背景121.3定義131.4參考資料132. 總體設(shè)計(jì)132.1需求概述132.2軟件結(jié)構(gòu)133. 程序描述133.1功能143.2性能143.3輸入項(xiàng)目143.4輸出項(xiàng)目143.5算法143.6程序邏輯143.7 接口 143.8存儲分配143.9限制條件143.1

10、0測試要點(diǎn)141引言1.1編寫目的【闡明編寫詳細(xì)設(shè)計(jì)說明書的目的，指明讀者對象?！?.2項(xiàng)目背景1.3定義【列出文檔中所用到的專門術(shù)語的定義和縮寫詞的原文?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括:l. 項(xiàng)目的計(jì)劃任務(wù)書、合同或批文；m. 項(xiàng)目開發(fā)計(jì)劃；n. 需求規(guī)格說明書；o. 概要設(shè)計(jì)說明書；p. 測試計(jì)劃（初稿）；q. 用戶操作手冊（初稿）；r. 文檔中所引用的其他資料、軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。】2 總體設(shè)計(jì)2.1需求概述2.2軟件結(jié)構(gòu)【如給出軟件系統(tǒng)的結(jié)構(gòu)圖。】3 程序描述【逐個模塊給出以下的說明：】計(jì)算機(jī)軟件開發(fā)文檔編寫指南3.1功能3.2性

11、能3.3輸入項(xiàng)目3.4輸出項(xiàng)目3.5算法【模塊所選用的算法?！?.6程序邏輯【詳細(xì)描述模塊實(shí)現(xiàn)的算法，可采用:a. 標(biāo)準(zhǔn)流程圖；b. PDL語言；c. N S 圖；d. PADe. 判定表等描述算法的圖表。】3.7 接口3.8存儲分配3.9限制條件3.10測試要點(diǎn)【給出測試模塊的主要測試要求。】計(jì)算機(jī)軟件開發(fā)文檔編寫指南五、用戶操作手冊1引言151.1編寫目的151.2項(xiàng)目背景161.3定義161.4參考資料162. 軟件概述162.1 目標(biāo)162.2功能162.3性能163 運(yùn)行環(huán)境163.1硬件163.2支持軟件174使用說明174.1安裝和初始化174.2輸入174.3輸出184.4出錯

12、和恢復(fù)184.5求助查詢185. 運(yùn)行說明185.1運(yùn)行表185.2運(yùn)行步驟186. 非常規(guī)過程 197. 操作命令一覽表 198. 程序文件（或命令文件）和數(shù)據(jù)文件一覽表 199. 用戶操作舉例201引言1.1編寫目的【闡明編寫手冊的目的，指明讀者對象。】計(jì)算機(jī)軟件開發(fā)文檔編寫指南1.2項(xiàng)目背景【應(yīng)包括項(xiàng)目的來源、委托單位、開發(fā)單位和主管部門?！?.3定義【列出手冊中所用到的專門術(shù)語的定義和縮寫詞的原文?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括:s. 項(xiàng)目的計(jì)劃任務(wù)書、合同或批文；t. 項(xiàng)目開發(fā)計(jì)劃；u. 需求規(guī)格說明書；v. 概要設(shè)計(jì)說明書；W

13、.詳細(xì)設(shè)計(jì)說明書；X. 測試計(jì)劃；y.手冊中引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范?！? 軟件概述2.1目標(biāo)2.2功能2.3性能a. 數(shù)據(jù)精確度【包括輸入、輸出及處理數(shù)據(jù)的精度。】b. 時間特性【如響應(yīng)時間、處理時間、數(shù)據(jù)傳輸時間等?！縞. 靈活性【在操作方式、運(yùn)行環(huán)境需做某些變更時軟件的適應(yīng)能力。】3 運(yùn)行環(huán)境3.1硬件【列出軟件系統(tǒng)運(yùn)行時所需的硬件最小配置，如a. 計(jì)算機(jī)型號、主存容量；b. 外存儲器、媒體、記錄格式、設(shè)備型號及數(shù)量；c. 輸入、輸出設(shè)備；d. 數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號及數(shù)量?！?.2支持軟件【如：a. 操作系統(tǒng)名稱及版本號；b. 語言編譯系統(tǒng)或匯編系統(tǒng)的

14、名稱及版本號;c. 數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號；d. 其他必要的支持軟件?！?. 使用說明4.1安裝和初始化【給出程序的存儲形式、操作命令、反饋信息及其含意、表明安裝完成的測試實(shí)例以及安裝 所需的軟件工具等?！?.2輸入【給出輸入數(shù)據(jù)或參數(shù)的要求?！?.2.1數(shù)據(jù)背景【說明數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。】4.2.2數(shù)據(jù)格式【如：a.長度；b.格式基準(zhǔn)；c.標(biāo)號；d.順序；e.分隔符；f.詞匯表；g.省略和重復(fù);h.控制?！坑?jì)算機(jī)軟件開發(fā)文檔編寫指南423輸入舉例4.3輸出【給出每項(xiàng)輸出數(shù)據(jù)的說明?！?.3.1數(shù)據(jù)背景【說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等?！?

15、.3.2數(shù)據(jù)格式【詳細(xì)闡明每一輸出數(shù)據(jù)的格式，如：首部、主體和尾部的具體形式。】4.3.3舉例4.4出錯和恢復(fù)【給出：a. 出錯信息及其含意；b. 用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動?！?.5求助查詢【說明如何操作。】5運(yùn)行說明5.1運(yùn)行表【列出每種可能的運(yùn)行情況，說明其運(yùn)行目的?！?.2運(yùn)行步驟【按順序說明每種運(yùn)行的步驟，應(yīng)包括：】計(jì)算機(jī)軟件開發(fā)文檔編寫指南5.2.1運(yùn)行控制5.2.2操作信息a.b.c.d.e.f.運(yùn)行目的；操作要求；啟動方法；預(yù)計(jì)運(yùn)行時間； 操作命令格式及說明;其他事項(xiàng)。5.2.3輸入/輸出文件【給出建立或更新文件的有關(guān)信息，如：】a. 文件的名稱及編號；b. 記錄媒

16、體；c. 存留的目錄；d. 文件的支配【說明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對象，占用硬 件的優(yōu)先級及保密控制等?！?.2.4啟動或恢復(fù)過程6. 非常規(guī)過程【提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯處理操作、向后備系統(tǒng)切換操作以及維護(hù)人員須知的操作和注意事項(xiàng)。】7. 操作命令一覽表【按字母順序逐個列出全部操作命令的格式、功能及參數(shù)說明?！?. 程序文件（或命令文件）和數(shù)據(jù)文件一覽 表【按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標(biāo)識符及說明。9. 用戶操作舉例六、測試計(jì)劃1引言201.1編寫目的201.2項(xiàng)目背景211.3定義211.4參考資料212.任務(wù)概述212

17、.1目標(biāo)212.2運(yùn)行環(huán)境212.3需求概述212.4條件與限制213計(jì)劃223.1測試方案223.2測試項(xiàng)目223.3測試準(zhǔn)備223.4測試機(jī)構(gòu)及人員 224測試項(xiàng)目說明224.1測試項(xiàng)目名稱及測試內(nèi)容 224.2測試用例224.3進(jìn)度234.4條件234.5測試資料235評價235.1范圍235.2準(zhǔn)則231引言1.1編寫目的1.2項(xiàng)目背景【說明項(xiàng)目的來源、委托單位及主管部門?！?.3定義【列出測試計(jì)劃中所用到的專門術(shù)語的定義和縮寫詞的原意。1.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括: 乙 項(xiàng)目的計(jì)劃任務(wù)書、合同或批文；aa.項(xiàng)目開發(fā)計(jì)劃；bb.需

18、求規(guī)格說明書；cc.概要設(shè)計(jì)說明書；dd.詳細(xì)設(shè)計(jì)說明書；ee.用戶操作手冊；ff.本測試計(jì)劃中引用的其他資料、采用的軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。】2 任務(wù)概述2.1目標(biāo)2.2運(yùn)行環(huán)境2.3需求概述2.4條件與限制計(jì)算機(jī)軟件開發(fā)文檔編寫指南3 計(jì)劃3.1測試方案【說明確定測試方法和選取測試用例的原則?！?.2測試項(xiàng)目【列出組裝測試和確認(rèn)測試中每一項(xiàng)測試的內(nèi)容、名稱、目的和進(jìn)度?！?.3測試準(zhǔn)備3.4測試機(jī)構(gòu)及人員【測試機(jī)構(gòu)名稱、負(fù)責(zé)人和職責(zé)?！?. 測試項(xiàng)目說明【按順序逐個對測試項(xiàng)目做出說明：】4.1測試項(xiàng)目名稱及測試內(nèi)容4.2測試用例4.2.1輸入【輸入的數(shù)據(jù)和輸入命令?！?.2.2輸出【預(yù)期的輸出

19、數(shù)據(jù)?！?23步驟及操作424允許偏差【給出實(shí)測結(jié)果與預(yù)期結(jié)果之間允許偏差的范圍?！?.3進(jìn)度4.4條件【給出測試對資源的特殊要求，如設(shè)備、軟件、人員等?！?.5測試資料【說明測試所需的資料。】5 評價5.1范圍【說明所完成的各項(xiàng)測試說明問題的范圍及其局限性?！?.2準(zhǔn)則【說明評價測試結(jié)果的準(zhǔn)則。】七、測試分析報(bào)告1 引言241.1編寫目的241.2項(xiàng)目背景241.3定義241.4參考資料242 測試計(jì)劃執(zhí)行情況 252.1測試項(xiàng)目252.2測試機(jī)構(gòu)和人員 252.3測試結(jié)果253 軟件需求測試結(jié)論 254評價254.1軟件能力254.2缺陷和限制 254.3建議264.4測試結(jié)論261引言1

20、.1編寫目的【闡明編寫測試分析報(bào)告的目的，指明讀者對象?！?.2項(xiàng)目背景【說明項(xiàng)目的來源、委托單位及主管部門?！?.3定義【列出測試分析報(bào)告中所用到的專門術(shù)語的定義和縮寫詞的原文?！縄. 4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：gg.項(xiàng)目的計(jì)劃任務(wù)書、合同或批文；hh.項(xiàng)目開發(fā)計(jì)劃；ii.需求規(guī)格說明書；jj.概要設(shè)計(jì)說明書；kk.詳細(xì)設(shè)計(jì)說明書；II. 用戶操作手冊；mm.測試計(jì)劃；nn.測試分析報(bào)告所引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工作規(guī)范。】2 測試計(jì)劃執(zhí)行情況2.1測試項(xiàng)目【列出每一測試項(xiàng)目的名稱、內(nèi)容和目的?！?.2測試機(jī)構(gòu)和人員【給

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

22、月內(nèi)的主要活動 262.2實(shí)際進(jìn)展與計(jì)劃比較 263. 所用工時274所用機(jī)時275. 經(jīng)費(fèi)支出276. 工作遇到的問題及采取的對策 277本月完成的成果27&下月的工作計(jì)劃 279.特殊問題271 報(bào)告時間及所處的開發(fā)階段2. 工程進(jìn)度2.1本月內(nèi)的主要活動2.2實(shí)際進(jìn)展與計(jì)劃比較3 所用工時【按不同層次人員分別計(jì)時?！? 所用機(jī)時【按所用計(jì)算機(jī)型分別計(jì)時。】5. 經(jīng)費(fèi)支出【分類列出本月經(jīng)費(fèi)支出項(xiàng)目，給出支出總額，并與計(jì)劃比較?！?. 工作遇到的問題及采取的對策7 本月完成的成果8. 下月的工作計(jì)劃9. 特殊問題九、項(xiàng)目開發(fā)總結(jié)報(bào)告1引言281.1編寫目的281.2項(xiàng)目背景281.3定義28

23、1.4參考資料282. 開發(fā)結(jié)果292.1產(chǎn)品2922主要功能及性能292.3所用工時292.4所用機(jī)時292.5進(jìn)度292.6費(fèi)用293評價293.1生產(chǎn)率評價293.2技術(shù)方案評價 303.3產(chǎn)品質(zhì)量評價 304. 經(jīng)驗(yàn)與教訓(xùn)301引言1.1編寫目的【闡明編寫總結(jié)報(bào)告的目的，指明讀者對象。】1.2項(xiàng)目背景【說明項(xiàng)目來源、委托單位、開發(fā)單位及主管部門?！?.3定義【列出報(bào)告用到的專門術(shù)語的定義和縮寫詞的原文?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：00.項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文；pp.項(xiàng)目開發(fā)計(jì)劃；qq.需求規(guī)格說明書；rr

24、.概要設(shè)計(jì)說明書；ss.詳細(xì)設(shè)計(jì)說明書；tt.用戶操作手冊；UU.測試計(jì)劃；vv.測試分析報(bào)告；計(jì)算機(jī)軟件開發(fā)文檔編寫指南WW.本報(bào)告引用的其他資料、采用的開發(fā)標(biāo)準(zhǔn)或開發(fā)規(guī)范。】2.開發(fā)結(jié)果2.1產(chǎn)品【可包括：a. 列出各部分的程序名稱、源程序行數(shù)（包括注釋行）或目標(biāo)程序字節(jié)數(shù)及程序總計(jì)數(shù)量、 存儲形式；b. 產(chǎn)品文檔名稱等?！?.2主要功能及性能2.3所用工時【按人員的不同層次分別計(jì)時?！?.4所用機(jī)時【按所用計(jì)算機(jī)機(jī)型分別計(jì)時?！?.5進(jìn)度【給出計(jì)劃進(jìn)度與實(shí)際進(jìn)度的對比?！?.6費(fèi)用3評價3.1生產(chǎn)率評價3.2技術(shù)方案評價3.3產(chǎn)品質(zhì)量評價4.經(jīng)驗(yàn)與教訓(xùn)十、程序維護(hù)手冊1引言311.1編寫

25、目的311.2開發(fā)單位311.3定義311.4參考資料312 系統(tǒng)說明312.1系統(tǒng)用途312.2安全保密312.3總體說明312.4程序說明323. 操作環(huán)境333.1設(shè)備333.2支持軟件333.3數(shù)據(jù)庫334 .維護(hù)過程344.1約定344.2驗(yàn)證過程344.3出錯及糾正方法 344.4專門維護(hù)過程344.5專用維護(hù)程序 344.6程序清單和流程圖 341 引言1.1編寫目的【闡明編寫手冊的目的，指明讀者對象?！?.2開發(fā)單位【說明項(xiàng)目的提出者、開發(fā)者、用戶和使用場所?！?.3定義【列出報(bào)告中所用到的專門術(shù)語的定義和縮寫詞的原文?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期

26、、出版單位或資料來源，以及保密級別，可 包括：xx.用戶操作手冊；yy.與本項(xiàng)目有關(guān)的其他文檔。】2 系統(tǒng)說明2.1系統(tǒng)用途【說明系統(tǒng)具備的功能，輸入和輸出?！?.2安全保密【說明系統(tǒng)安全保密方面的考慮。】2.3總體說明【說明系統(tǒng)的總體功能，對系統(tǒng)、子系統(tǒng)和作業(yè)做出綜合性的介紹，并用圖表的方式給出系統(tǒng)主要部分的內(nèi)部關(guān)系?！?.4程序說明【說明系統(tǒng)中每一程序、分程序的細(xì)節(jié)和特性?！?.4.1程序1的說明2.4.1.1 功能【說明程序的功能。】2.4.1.2 方法【說明實(shí)現(xiàn)方法?！?.4.1.3 輸入【說明程序的輸入、媒體、運(yùn)行數(shù)據(jù)記錄、運(yùn)行開始時使用的輸入數(shù)據(jù)的類型和存 放單元、與程序初始化有關(guān)

27、的入口要求?！?.4.1.4 處理【處理特點(diǎn)和目的，如：a. 用圖表說明程序中的運(yùn)行邏輯流程；b. 程序主要轉(zhuǎn)移條件；c. 對程序的約束條件；d. 程序結(jié)束時的出口要求；e. 與下一個程序的通信與聯(lián)結(jié)（運(yùn)行、控制）；f. 由該程序產(chǎn)生并供處理程序段使用的輸出數(shù)據(jù)類型和存放單元；g. 程序運(yùn)行所用存儲量、類型及存儲位置等?！?.4.1.5 輸出【程序的輸出?！?.4.1.6 接口【本程序與本系統(tǒng)其他部分的接口?！?.4.1.7 表格【說明程序內(nèi)部的各種表、項(xiàng)的細(xì)節(jié)和特性。對每張表的說明至少包括：a. 表的標(biāo)識符；b. 使用目的；c. 使用此表的其他程序；d. 邏輯劃分，如塊或部，不包括表項(xiàng)；e.

28、 表的基本結(jié)構(gòu)；f. 設(shè)計(jì)安排，包括表的控制信息。表目結(jié)構(gòu)細(xì)節(jié)、使用中的特有性質(zhì)及各表項(xiàng)的標(biāo)識、位置、用途、類型、編碼表示?！?.4.1.8特有的運(yùn)行性質(zhì)【說明在用戶操作手冊中沒有提到的運(yùn)行性質(zhì)?！?.4.2程序2的說明【與程序1的說明相同。以后其他各程序的說明相同?！? 操作環(huán)境3.1設(shè)備【逐項(xiàng)說明系統(tǒng)的設(shè)備配置及其特性。】3.2支持軟件【列出系統(tǒng)使用的支持軟件，包括它們的名稱和版本號?！?.3數(shù)據(jù)庫【說明每個數(shù)據(jù)庫的性質(zhì)和內(nèi)容，包括安全考慮?！?.3.1總體特征【如：a. 標(biāo)識符；b. 使用這些數(shù)據(jù)庫的程序；c. 靜態(tài)數(shù)據(jù)；d. 動態(tài)數(shù)據(jù)；e. 數(shù)據(jù)庫的存儲媒體；f. 程序使用數(shù)據(jù)庫的限制

29、?！?.3.2結(jié)構(gòu)及詳細(xì)說明3.3.2.1說明該數(shù)據(jù)庫的結(jié)構(gòu)，包括其中的記錄和項(xiàng)；3.3.2.2 說明記錄的組成，包括首部或控制段、記錄體；3.3.2.3 說明每個記錄結(jié)構(gòu)的字段，包括：標(biāo)記或標(biāo)號、字段的字符長度和位數(shù)、該字段的 充許值范圍。3.3.2.4 擴(kuò)充：說明為記錄追加字段的規(guī)定;計(jì)算機(jī)軟件開發(fā)文檔編寫指南4 維護(hù)過程4.1約定【列出該軟件系統(tǒng)設(shè)計(jì)中所使用全部規(guī)則和約定，包括：a. 程序、分程序、記錄、字段和存儲區(qū)的標(biāo)識或標(biāo)號助記符的使用規(guī)則；b. 圖表的處理標(biāo)準(zhǔn)、卡片的連接順序、語句和記號中使用的縮寫、出現(xiàn)在圖表中的符號名；c. 使用的軟件技術(shù)標(biāo)準(zhǔn)；d. 標(biāo)準(zhǔn)化的數(shù)據(jù)元素及其特征?！?/p>

30、4.2驗(yàn)證過程【說明一個程序段修改后，對其進(jìn)行驗(yàn)證的要求和過程（包括測試程序和數(shù)據(jù)）及程序周期 性驗(yàn)證的過程?！?.3出錯及糾正方法【列出出錯狀態(tài)及其糾正方法?！?.4專門維護(hù)過程【說明文檔其他地方?jīng)]有提到的專門維護(hù)過程，如：a. 維護(hù)該軟件系統(tǒng)的輸入輸出部分（如數(shù)據(jù)庫）的要求、過程和驗(yàn)證方法；b. 運(yùn)行程序庫維護(hù)系統(tǒng)所必需的要求、過程和驗(yàn)證方法；c. 對閏年、世紀(jì)變更所需的臨時性修改等?！?.5專用維護(hù)程序【列出維護(hù)軟件系統(tǒng)使用的后備技術(shù)和專用程序（如文件恢復(fù)程序、淘汰過時文件的程序等）的目錄，并加以說明，內(nèi)容包括：a. 維護(hù)作業(yè)的輸入輸出要求；b. 輸入的詳細(xì)過程及在硬設(shè)備上建立、運(yùn)行并完

31、成維護(hù)作業(yè)的操作步驟。】4.6程序清單和流程圖【引用資料或提供附錄給出程序清單和流程圖。】計(jì)算機(jī)軟件開發(fā)文檔編寫指南十一、軟件問題報(bào)告1登記號352登記日期353問題發(fā)現(xiàn)日期354. 活動365狀態(tài)366. 報(bào)告人367. 問題屬于什么方面 36&模塊/子系統(tǒng)369.修訂版本號3610磁帶3711. 數(shù)據(jù)庫3712. 文件號3713. 測試用例3714. 硬件3715. 問題描述/影響3716. 附注371. 登記號【由軟件配置管理部門為該報(bào)告規(guī)定一個唯一的、順序的編號。】2. 登記日期【軟件配置管理部門登記該報(bào)告的日期?！?. 問題發(fā)現(xiàn)日期【發(fā)現(xiàn)該問題的日期和時間?！? 活動【在哪個階段發(fā)現(xiàn)

32、的問題，分為單元測試、組裝測試、確認(rèn)測試和運(yùn)行維護(hù)。5. 狀態(tài)【在軟件配置記錄中維護(hù)的動態(tài)指示，狀態(tài)表示有：a. 正在復(fù)查“軟件問題報(bào)告”，以確定將采取什么行動；b. 軟件問題報(bào)告”已由指定的人去進(jìn)行處理；c. 修改已完成，并經(jīng)過測試，正準(zhǔn)備交給主程序庫；d. 主程序庫已經(jīng)更新，主程序庫修改的重新測試尚未完成；e. 做了重新測試，問題再現(xiàn)；f. 做了重新測試，所做的修改已無故障，“軟件問題報(bào)告”被關(guān)閉；g. 留待以后關(guān)閉?！? 報(bào)告人【填寫“軟件問題報(bào)告”人員的姓名、地址、電話?！?. 問題屬于什么方面也可能是它們的【區(qū)分是程序的問題，還是模塊的問題，或是數(shù)據(jù)庫的問題， 文件的問題。某種組合?！? 模塊/子系統(tǒng)【出現(xiàn)的模塊名。如果不知是哪個模塊，可標(biāo)出子系統(tǒng)名，盡量給出細(xì)節(jié)。9.修訂版本號【出現(xiàn)問題的模塊版本。】10 磁帶【包含有問題的模塊的主程序庫的磁帶的標(biāo)識符?！?1. 數(shù)據(jù)庫【當(dāng)發(fā)現(xiàn)問題時所使用數(shù)據(jù)庫的標(biāo)識符。 】12. 文件號【有錯誤的文件的編號?！?3. 測試用例【發(fā)現(xiàn)錯誤時所使用測試用例的標(biāo)識符。 】1