軟件開發(fā)項目文檔

1、 在項目開發(fā)過程中，文檔編制要求具有針對性、在項目開發(fā)過程中，文檔編制要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性。精確性、清晰性、完整性、靈活性、可追溯性。 v 可行性分析報告可行性分析報告：說明該軟件開發(fā)項目的實現在技術上、經濟上和社會因素上的可行性，評述為了合理地達到開發(fā)目標可供選擇的各種可能實施方案，說明并論證所選定實施方案的理由。 v 項目開發(fā)計劃項目開發(fā)計劃：為軟件項目實施方案制訂出具體計劃，應該包括各部分工作的負責人員、開發(fā)的進度、開發(fā)經費的預算、所需的硬件及軟件資源等。 軟件開發(fā)項目文檔 v 軟件需求說明書（軟件規(guī)格說明書）軟件需求說明書（軟件規(guī)格說明書）：對所開發(fā)

2、軟件的功能、性能、用戶界面及運行環(huán)境等作出詳細的說明。它是在用戶與開發(fā)人員雙方對軟件需求取得共同理解并達成協(xié)議的條件下編寫的，也是實施開發(fā)工作的基礎。該說明書應給出數據邏輯和數據采集的各項要求，為生成和維護系統(tǒng)數據文件做好準備。 v 概要設計說明書概要設計說明書：該說明書是概要實際階段的工作成果，它應說明功能分配、模塊劃分、程序的總體結構、輸入輸出以及接口設計、運行設計、數據結構設計和出錯處理設計等，為詳細設計提供基礎。 v詳細設計說明書詳細設計說明書：著重描述每一模塊是怎樣實現的，包括實現算法、邏輯流程等。 軟件開發(fā)項目文檔 v 用戶操作手冊用戶操作手冊：本手冊詳細描述軟件的功能、性能和用戶

3、界面，使用戶對如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運行情況的有關知識，特別是操作方法的具體細節(jié)。 v 測試計劃測試計劃：為做好集成測試和驗收測試，需為如何組織測試制訂實施計劃。計劃應包括測試的內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差范圍等。 v 測試分析報告測試分析報告：測試工作完成以后，應提交測試計劃執(zhí)行情況的說明，對測試結果加以分析，并提出測試的結論意見。 v 開發(fā)進度月報開發(fā)進度月報：該月報系軟件人員按月向管理部門提交的項目進展情況報告，報告應包括進度計劃與實際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。 軟件開發(fā)項目文檔

4、v 項目開發(fā)總結報告項目開發(fā)總結報告：軟件項目開發(fā)完成以后，應與項目實施計劃對照，總結實際執(zhí)行的情況，如進度、成果、資源利用、成本和投入的人力，此外，還需對開發(fā)工作做出評價，總結出經驗和教訓。 v 軟件維護手冊軟件維護手冊：主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護過程的說明，便于軟件的維護。 v 軟件問題報告軟件問題報告：指出軟件問題的登記情況，如日期、發(fā)現人、狀態(tài)、問題所屬模塊等，為軟件修改提供準備文檔。 v 軟件修改報告軟件修改報告：軟件產品投入運行以后，發(fā)現了需對其進行修正、更改等問題，應將存在的問題、修改的考慮以及修改的影響作出詳細的描述，提交審批。 軟件開發(fā)

5、項目文檔 一、可行性分析報告一、可行性分析報告1.1 編寫目的：闡明編寫可行性研究報告的目的，提出讀者對編寫目的：闡明編寫可行性研究報告的目的，提出讀者對象。象。 1.2 項目背景：應包括項目背景：應包括 所建議開發(fā)軟件的名稱所建議開發(fā)軟件的名稱 項目的任務提出者、開發(fā)者、用戶及實現軟件的單位項目的任務提出者、開發(fā)者、用戶及實現軟件的單位 項目與其他軟件或其他系統(tǒng)的關系。項目與其他軟件或其他系統(tǒng)的關系。 1.3 定義：列出文檔中用到的專門術語的定義和縮寫詞的原文。定義：列出文檔中用到的專門術語的定義和縮寫詞的原文。 1.4 參考資料：列出有關資料的作者、標題、編號、發(fā)表日期、參考資料：列出有關

6、資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可包括出版單位或資料來源，可包括 項目經核準的計劃任務書、合同或上級機關的批文項目經核準的計劃任務書、合同或上級機關的批文 與項目有關的已發(fā)表的資料與項目有關的已發(fā)表的資料 文檔中所引用的資料，所采用的軟件標準或規(guī)范文檔中所引用的資料，所采用的軟件標準或規(guī)范 2 可行性研究的前提可行性研究的前提 2.1 要求：列出并說明建議開發(fā)軟件的的基本要求，如要求：列出并說明建議開發(fā)軟件的的基本要求，如 功能功能 性能性能 輸入輸入/輸出輸出 基本的數據流程和處理流程基本的數據流程和處理流程 安全與保密要求安全與保密要求 與軟件相關的其他系統(tǒng)與軟件相關

7、的其他系統(tǒng) 完成日期完成日期 2.2 目標：可包括目標：可包括 人力與設備費用的節(jié)省人力與設備費用的節(jié)省 處理速度的提高處理速度的提高 控制精度或生產力的提高控制精度或生產力的提高 管理信息服務的改進管理信息服務的改進 決策系統(tǒng)的改進決策系統(tǒng)的改進 人員工作效率的提高人員工作效率的提高 2.3 條件、假定和限制：可包括條件、假定和限制：可包括 建議開發(fā)軟件運行的最短壽命建議開發(fā)軟件運行的最短壽命 進行顯然方案選擇比較的期限進行顯然方案選擇比較的期限 經費來源和使用限制經費來源和使用限制 法律和政策方面的限制法律和政策方面的限制 硬件、軟件、運行環(huán)境和開發(fā)環(huán)境的條件和限制硬件、軟件、運行環(huán)境和開

8、發(fā)環(huán)境的條件和限制 可利用的信息和資源可利用的信息和資源 建議開發(fā)軟件投入使用的最遲時間建議開發(fā)軟件投入使用的最遲時間 2.4 可行性研究方法可行性研究方法 2.5 決定可行性的主要因素決定可行性的主要因素 3 對現有系統(tǒng)的分析對現有系統(tǒng)的分析 3.1 處理流程和數據流程處理流程和數據流程 3.2 工作負荷工作負荷 3.3 費用支出：如人力、設備、空間、支持性服務、材料等項費用支出：如人力、設備、空間、支持性服務、材料等項開支開支 3.4 人員：列出所需人員的專業(yè)技術類別和數量人員：列出所需人員的專業(yè)技術類別和數量 3.5 設備設備 3.6 局限性：說明現有系統(tǒng)存在的問題以及為什么需要開發(fā)新局

9、限性：說明現有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng)的系統(tǒng) 4 所建議技術可行性分析所建議技術可行性分析 4.1 對系統(tǒng)的簡要描述對系統(tǒng)的簡要描述 4.2 與現有系統(tǒng)比較的優(yōu)越性與現有系統(tǒng)比較的優(yōu)越性 4.3 處理流程和數據流程處理流程和數據流程 4.4 采用建議系統(tǒng)可能帶來的影響采用建議系統(tǒng)可能帶來的影響 對設備的影響對設備的影響 對現有軟件的影響對現有軟件的影響 對用戶的影響對用戶的影響 對系統(tǒng)運行的影響對系統(tǒng)運行的影響 對開發(fā)環(huán)境的影響對開發(fā)環(huán)境的影響 對經費支出的影響對經費支出的影響 4.5 技術可行性評價技術可行性評價:包括包括 在限制條件下，功能目的是否達到在限制條件下，功能目的

10、是否達到 利用現有技術，功能目的是否達到利用現有技術，功能目的是否達到 對開發(fā)人員數量和質量的要求，并說明能否滿足對開發(fā)人員數量和質量的要求，并說明能否滿足 在規(guī)定的期限內，開發(fā)能否完成在規(guī)定的期限內，開發(fā)能否完成 5 所建議系統(tǒng)經濟可行性分析所建議系統(tǒng)經濟可行性分析 5.1 支出支出 5.2 效益效益 5.3 收益收益/投資比投資比 5.4 投資回收周期投資回收周期 5.5 敏感性分析：指一些關鍵性因素，如：敏感性分析：指一些關鍵性因素，如： 系統(tǒng)生存周期長短系統(tǒng)生存周期長短 系統(tǒng)工作負荷量系統(tǒng)工作負荷量 處理速度要求處理速度要求 設備和軟件配置變化對支出和效益的影響等的分析設備和軟件配置變

11、化對支出和效益的影響等的分析 6 社會因素可行性分析社會因素可行性分析 6.1 法律因素：如法律因素：如 合同責任合同責任 侵犯專利權侵犯專利權 侵犯版權侵犯版權 6.2 用戶使用可行性：如用戶使用可行性：如 用戶單位的行政管理用戶單位的行政管理 工作制度工作制度 人員素質等能否滿足要求人員素質等能否滿足要求7 其他可供選擇的方案其他可供選擇的方案 逐個闡明其它可供選擇的方案，重點說明未被推薦的理由。逐個闡明其它可供選擇的方案，重點說明未被推薦的理由。 8 結論意見結論意見 可著手組織開發(fā)可著手組織開發(fā) 需等待若干條件具備后才能開發(fā)需等待若干條件具備后才能開發(fā) 需對開發(fā)目標進行某些修改需對開發(fā)

12、目標進行某些修改 不能進行或不必進行不能進行或不必進行 其它其它 二、項目開發(fā)計劃二、項目開發(fā)計劃 1 引言引言 1.1 編寫目的：闡明編寫可行性研究報告的目的，提出讀者對象編寫目的：闡明編寫可行性研究報告的目的，提出讀者對象 1.2 項目背景：應包括項目背景：應包括 項目的委托單位、開發(fā)單位和主管部門；項目的委托單位、開發(fā)單位和主管部門； 該軟件系統(tǒng)與其他系統(tǒng)的關系。該軟件系統(tǒng)與其他系統(tǒng)的關系。 1.3 定義：列出文檔中用到的專門術語的定義和縮寫詞的原文定義：列出文檔中用到的專門術語的定義和縮寫詞的原文 1.4 參考資料：可包括：參考資料：可包括： 項目經核準的計劃任務書、合同或上級機關的批

13、文項目經核準的計劃任務書、合同或上級機關的批文 文檔所引用的資料、規(guī)范等文檔所引用的資料、規(guī)范等 列出這些資料的作者、標題、編號、發(fā)表日期、出版單列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源；位或資料來源； 2 項目概述項目概述 2.1 工作內容工作內容:簡要說明項目的各項主要工作，介紹所開發(fā)軟件簡要說明項目的各項主要工作，介紹所開發(fā)軟件的功能、性能等；若不編寫可行性研究報告；則應在本節(jié)給的功能、性能等；若不編寫可行性研究報告；則應在本節(jié)給出較詳細的介紹；出較詳細的介紹； 2.2 條件與限制條件與限制: 闡明為完成項目應具備的條件、開發(fā)單位已具闡明為完成項目應具備的條件、開發(fā)單

14、位已具備的條件以及尚需創(chuàng)造的條件。必要時還應說明用戶及分合備的條件以及尚需創(chuàng)造的條件。必要時還應說明用戶及分合同承擔的工作、完成期限及其他條件與限制。同承擔的工作、完成期限及其他條件與限制。 2.3 產品產品 2.3.1程序：列出應交付的程序名稱、使用的語言及存儲形式。程序：列出應交付的程序名稱、使用的語言及存儲形式。 2.3.2文檔：列出應交付的文檔。文檔：列出應交付的文檔。 2.4 運行環(huán)境：應包括硬件環(huán)境、軟件環(huán)境。運行環(huán)境：應包括硬件環(huán)境、軟件環(huán)境。 2.5 服務：闡明開發(fā)單位可向用戶提供的服務。如人員培訓、服務：闡明開發(fā)單位可向用戶提供的服務。如人員培訓、安裝、保修、維護和其他運行支

15、持。安裝、保修、維護和其他運行支持。 2.6 驗收標準驗收標準 3 實施計劃實施計劃 3.1 任務分解：任務的劃分及各項任務的負責人。任務分解：任務的劃分及各項任務的負責人。 3.2 進度：按階段完成的項目，用圖表說明開始時間、完成時進度：按階段完成的項目，用圖表說明開始時間、完成時間。間。 3.3 預算預算 3.4 關鍵問題：說明可能影響項目的關鍵問題，如設備條件、關鍵問題：說明可能影響項目的關鍵問題，如設備條件、技術難點或其他風險因素，并說明對策。技術難點或其他風險因素，并說明對策。 4 人員組織及分工人員組織及分工 5 交付期限交付期限 6 專題計劃要點專題計劃要點 如測試計劃、質量保證

16、計劃、配置管理計劃、人員培訓計如測試計劃、質量保證計劃、配置管理計劃、人員培訓計劃、系統(tǒng)安裝計劃等。劃、系統(tǒng)安裝計劃等。 三、軟件需求說明書三、軟件需求說明書 1 引言引言 1.1 編寫目的：闡明編寫需求說明書的目的，指明讀者對象。編寫目的：闡明編寫需求說明書的目的，指明讀者對象。 1.2 項目背景：應包括項目背景：應包括 項目的委托單位、開心單位和主管部門；項目的委托單位、開心單位和主管部門； 該軟件系統(tǒng)與其他系統(tǒng)的關系。該軟件系統(tǒng)與其他系統(tǒng)的關系。 1.3 定義：列出文檔中所用到的專門術語的定義和縮寫詞的愿定義：列出文檔中所用到的專門術語的定義和縮寫詞的愿文。文。 1.4 參考資料：可包括

17、參考資料：可包括 項目經核準的計劃任務書、合同或上級機關的批文項目經核準的計劃任務書、合同或上級機關的批文 文檔所引用的資料、規(guī)范等文檔所引用的資料、規(guī)范等 列出這些資料的作者、標題、編號、發(fā)表日期、出版單列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源位或資料來源 2 任務概述任務概述 2.1 目標目標 2.2 運行環(huán)境運行環(huán)境 2.3 條件與限制條件與限制 3 數據描述數據描述 3.1 表態(tài)數據表態(tài)數據 3.2 動態(tài)數據：包括輸入數據和輸出數據。動態(tài)數據：包括輸入數據和輸出數據。 3.3 數據庫描述：給出使用數據庫的名稱和類型。數據庫描述：給出使用數據庫的名稱和類型。 3.4

18、數據詞典數據詞典 3.5 數據采集數據采集 4 功能需求功能需求 4.1功能劃分功能劃分 4.2功能描述功能描述 5 性能需求性能需求 5.1 數據精確度數據精確度 5.2 時間特性：如響應時間、更新處理時間、數據轉換與傳輸時間特性：如響應時間、更新處理時間、數據轉換與傳輸時間、運行時間等。時間、運行時間等。 5.3 適應性：在操作方式、運行環(huán)境、與其他軟件的接口以及適應性：在操作方式、運行環(huán)境、與其他軟件的接口以及開發(fā)計劃等發(fā)生變化時，應具有的適應能力。開發(fā)計劃等發(fā)生變化時，應具有的適應能力。 6 運行需求運行需求 6.1 用戶界面：如屏幕格式、報表格式、菜單格式、輸入輸出用戶界面：如屏幕格

19、式、報表格式、菜單格式、輸入輸出時間等。時間等。 6.2 硬件接口硬件接口 6.3 軟件接口軟件接口 6.4 故障處理故障處理 7 其他需求其他需求 如可使用性、安全保密、可維護性、可移植性等。如可使用性、安全保密、可維護性、可移植性等。 四、概要設計說明書四、概要設計說明書 1 引言引言 1.1 寫目的：闡明編寫概要設計說明書的目的，指明讀者對象。寫目的：闡明編寫概要設計說明書的目的，指明讀者對象。 1.2 項目背景：應包括項目背景：應包括 項目的委托單位、開發(fā)單位和主管部門項目的委托單位、開發(fā)單位和主管部門 該軟件系統(tǒng)與其他系統(tǒng)的關系。該軟件系統(tǒng)與其他系統(tǒng)的關系。 1.3 定義：列出本文檔

20、中所用到的專門術語的定義和縮寫詞的定義：列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。愿意。 1.4 參考資料：參考資料： 列出這些資料的作者、標題、編號、發(fā)表日期、出版單列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源位或資料來源 項目經核準的計劃任務書、合同或上級機關的批文；項項目經核準的計劃任務書、合同或上級機關的批文；項目開發(fā)計劃；需求規(guī)格說明書；測試計劃（初稿）；用戶操目開發(fā)計劃；需求規(guī)格說明書；測試計劃（初稿）；用戶操作手冊作手冊 文檔所引用的資料、采用的標準或規(guī)范。文檔所引用的資料、采用的標準或規(guī)范。 2 任務概述任務概述 2.1 目標目標 2.2 需求概述需求概

21、述 2.3 條件與限制條件與限制 3 總體設計總體設計 3.2 總體結構和模塊外部設計總體結構和模塊外部設計 3.3 功能分配：表明各項功能與程序結構的關系。功能分配：表明各項功能與程序結構的關系。 4 接口設計接口設計 4.1 外部接口：包括用戶界面、軟件接口與硬件接口。外部接口：包括用戶界面、軟件接口與硬件接口。 4.2 內部接口：模塊之間的接口。內部接口：模塊之間的接口。 5 數據結構設計數據結構設計 6 邏輯結構設計邏輯結構設計 所有文檔的統(tǒng)一封面格式如下頁所示。所有文檔的統(tǒng)一封面格式如下頁所示。 7 物理結構設計物理結構設計 8 數據結構與程序的關系數據結構與程序的關系 9 運行設計

22、運行設計 9.1 運行模塊的組合運行模塊的組合 9.2 運行控制運行控制 9.3 運行時間運行時間 10 出錯處理設計 10.1 出錯輸出信息 10.2 出錯處理對策：如設置后備、性能降級、恢復及再啟動等。 11 安全保密設計 12 維護設計 說明為方便維護工作的設施，如維護模塊等。 五、詳細設計說明書五、詳細設計說明書 1 引言引言 1.1 編寫目的：闡明編寫詳細設計說明書的目的，指明讀者對編寫目的：闡明編寫詳細設計說明書的目的，指明讀者對象。象。 1.2 項目背景：應包括項目的來源和主管部門等。項目背景：應包括項目的來源和主管部門等。 1.3 定義：列出本文檔中所用到的專門術語的定義和縮寫

23、詞的定義：列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。愿意。 1.4 參考資料：參考資料： 列出有關資料的作者、標題、編號、發(fā)表日期、出版單列出有關資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源位或資料來源 項目經核準的計劃任務書、合同或上級機關的批文；項項目經核準的計劃任務書、合同或上級機關的批文；項目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；測試計劃目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；測試計劃（初稿）；用戶操作手冊（初稿）；用戶操作手冊 文檔所引用的資料、軟件開發(fā)的標準或規(guī)范。文檔所引用的資料、軟件開發(fā)的標準或規(guī)范。 2 總體設計總體設計 2.1 需求概述需求概述 2.

24、2 軟件結構：如給出軟件系統(tǒng)的結構圖。軟件結構：如給出軟件系統(tǒng)的結構圖。 3 程序描述程序描述 3.1 逐個模塊給出以下說明：逐個模塊給出以下說明： 功能功能 性能性能 輸入項目輸入項目 輸出項目輸出項目 3.2 算法：模塊所選用的算法。算法：模塊所選用的算法。 3.3 程序邏輯：詳細描述模塊實現的算法，可采用：標準流程程序邏輯：詳細描述模塊實現的算法，可采用：標準流程圖；圖；PDL語言；語言；N-S圖；判定表等描述算法的圖表。圖；判定表等描述算法的圖表。 3.4 接口接口 存儲分配存儲分配 限制條件限制條件 3.5測試要點：給出測試模塊的主要測試要求。測試要點：給出測試模塊的主要測試要求。

25、六、用戶操作手冊六、用戶操作手冊 1 引言引言 1.1 編寫目的：闡明編寫手冊的目的，指明讀者對象。編寫目的：闡明編寫手冊的目的，指明讀者對象。 1.2 項目背景：說明項目的來源、委托單位、開發(fā)單位及和主項目背景：說明項目的來源、委托單位、開發(fā)單位及和主管部門。管部門。 1.3 定義：列出手冊中使用的專門術語的定義和縮寫詞的愿意。定義：列出手冊中使用的專門術語的定義和縮寫詞的愿意。 1.4 參考資料：參考資料： 列出有關資料的作者、標題、編號、發(fā)表日期、出版單列出有關資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源位或資料來源 項目經核準的計劃任務書、合同或上級機關的批文；項項目經核準的計

26、劃任務書、合同或上級機關的批文；項目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；詳細設計目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；詳細設計說明書；測試計劃說明書；測試計劃 文檔中所引用的其他資料、采用的軟件工程標準或軟件文檔中所引用的其他資料、采用的軟件工程標準或軟件工程規(guī)范。工程規(guī)范。 2 軟件概述軟件概述 2.1 目標目標 2.2 功能功能 2.3 性能性能 2.4 數據精確度：包括輸入、輸出及處理數據的精度。數據精確度：包括輸入、輸出及處理數據的精度。 2.5 時間特性：如響應時間、處理時間、數據傳輸時間等。時間特性：如響應時間、處理時間、數據傳輸時間等。 2.6 靈活性：在操作方式、運

27、行環(huán)境需做某些變更時軟件的適應能力。靈活性：在操作方式、運行環(huán)境需做某些變更時軟件的適應能力。3 運行環(huán)境運行環(huán)境 3.1 硬件硬件 列出軟件系統(tǒng)運行時所需的硬件最小配置，如計算機型號、主存容列出軟件系統(tǒng)運行時所需的硬件最小配置，如計算機型號、主存容量量 外存儲器、媒體、記錄格式、設備型號及數量外存儲器、媒體、記錄格式、設備型號及數量 輸入、輸出設備輸入、輸出設備 數據傳輸設備及數據轉換設備的型號及數量。數據傳輸設備及數據轉換設備的型號及數量。 3.2 支持軟件支持軟件 操作系統(tǒng)名稱及版本號操作系統(tǒng)名稱及版本號 語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號 數據庫管

28、理系統(tǒng)的名稱及版本號數據庫管理系統(tǒng)的名稱及版本號 其他必要的支持軟件其他必要的支持軟件 4 使用說明使用說明 4.1 安裝和初始化：給出程序的存儲形式、操作命令、反饋信安裝和初始化：給出程序的存儲形式、操作命令、反饋信息及其做含意、表明安裝完成的測試實例以及安裝所需的軟息及其做含意、表明安裝完成的測試實例以及安裝所需的軟件工具等。件工具等。 4.2 輸入：給出輸入數據或參數的要求。輸入：給出輸入數據或參數的要求。 數據背景：說明數據來源、存儲媒體、出現頻度、限制數據背景：說明數據來源、存儲媒體、出現頻度、限制和質量管理等。和質量管理等。 數據格式數據格式:如長度、格式基準、標號、順序、分隔符、

29、如長度、格式基準、標號、順序、分隔符、詞匯表、省略和重復、控制。詞匯表、省略和重復、控制。 輸入舉例。輸入舉例。 4.3 輸出：給出每項輸出數據的說明。輸出：給出每項輸出數據的說明。 數據背景：說明輸出數據的去向、使用頻度、存放媒體數據背景：說明輸出數據的去向、使用頻度、存放媒體及質量管理等。及質量管理等。 數據格式：詳細闡明每一輸出數據的格式，如首部、主數據格式：詳細闡明每一輸出數據的格式，如首部、主體和尾部的具體形式。體和尾部的具體形式。 舉例舉例 4.4 出錯和恢復：給出出錯信息及其含意；用戶應采取的措施，出錯和恢復：給出出錯信息及其含意；用戶應采取的措施，如修改、恢復、再啟動。如修改、

30、恢復、再啟動。 4.5 求助查詢：說明如何操作。求助查詢：說明如何操作。 5 運行說明運行說明 5.1 運行表：列出每種可能的運行情況，說明其運行目的。運行表：列出每種可能的運行情況，說明其運行目的。 5.2 運行步驟：按順序說明每和運行的步驟，應包括：運行步驟：按順序說明每和運行的步驟，應包括： 5.3 運行控制運行控制 5.4 操作信息：運行目的、運行目的、操作要求、啟動方法、操作信息：運行目的、運行目的、操作要求、啟動方法、預計運行時間、操作命令格式及說明、其他事項；預計運行時間、操作命令格式及說明、其他事項； 5.5輸入輸入/輸出文件：給出建立或更新文件的有關信息，如：文輸出文件：給出

31、建立或更新文件的有關信息，如：文件的名稱及編號；記錄媒體；存留的目錄；文件的支配：說件的名稱及編號；記錄媒體；存留的目錄；文件的支配：說明確定保留文件或廢棄文件的準則，分發(fā)文件的對象，戰(zhàn)勝明確定保留文件或廢棄文件的準則，分發(fā)文件的對象，戰(zhàn)勝硬件的優(yōu)先級及保密控制等。硬件的優(yōu)先級及保密控制等。 5.6 啟動或恢復過程啟動或恢復過程 6 非常規(guī)過程非常規(guī)過程 提供應急戒非常規(guī)操作的必要信息及操作步驟，如出錯處提供應急戒非常規(guī)操作的必要信息及操作步驟，如出錯處理操作、向后備系統(tǒng)切換操作及維護人員須知的操作和注意理操作、向后備系統(tǒng)切換操作及維護人員須知的操作和注意事項。事項。 7 操作命令一覽表操作命

32、令一覽表 按字母順序逐個列出全部操作命令的格式、功能及參數說按字母順序逐個列出全部操作命令的格式、功能及參數說明。明。 8 程序文件（或命令文件）和數據文件一覽表程序文件（或命令文件）和數據文件一覽表 按文件名字母順序或按功能與模塊分類順序逐個列出文件按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明。名稱、標識符及說明。 9 用戶操作舉例用戶操作舉例 七、測試計劃七、測試計劃 1 引言引言 1.1 編寫目的：闡明編寫測試計劃的目的并指明讀者對象。編寫目的：闡明編寫測試計劃的目的并指明讀者對象。 1.2 項目背景：說明項目的來源、委托單位及主管部門。項目背景：說明項目的來源、

33、委托單位及主管部門。 1.3 定義：列出測試定義：列出測試 計劃中所用到的專門術語的定義和縮寫詞計劃中所用到的專門術語的定義和縮寫詞的原意。的原意。 1.4參考資料：列出有關資料的作者、標題、編號、發(fā)表日期、參考資料：列出有關資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：項目的計劃任務書、合同或出版單位或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；批文；項目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；詳細設計說明書；用戶操作手冊；本測試計劃中引用的其他詳細設計說明書；用戶操作手冊；本測試計劃中引用的其他資料、采用資料、采用 的軟件

34、開發(fā)標準或規(guī)范。的軟件開發(fā)標準或規(guī)范。 2 任務概述任務概述 2.1 目標目標 2.2 運行環(huán)境運行環(huán)境 2.3 需求概述需求概述 2.4 條件與限制條件與限制 3 計劃計劃 3.1 測試方案：說明測試方法和選取測試用例的原則。測試方案：說明測試方法和選取測試用例的原則。 3.2 測試項目：列出組裝測試和確認測試中每一項測試的內容、測試項目：列出組裝測試和確認測試中每一項測試的內容、名稱、目的和進度。名稱、目的和進度。 3.3 測試準備測試準備 3.4 測試機構及人員：測試機構名稱、負責人和職責。測試機構及人員：測試機構名稱、負責人和職責。 4 測試項目說明測試項目說明 4.1 按順序逐個對測

35、試項目做出說明按順序逐個對測試項目做出說明 4.1.1 測試項目名稱及測試內容測試項目名稱及測試內容 4.1.2 測試用例測試用例 4.1.3 輸入：輸入的數據和輸入命令。輸入：輸入的數據和輸入命令。 4.1.4 輸出：預期的輸出數據。輸出：預期的輸出數據。 4.2 步驟及操作步驟及操作 4.3 允許偏差：給出實測結果與預期結果之間允許偏差的范圍。允許偏差：給出實測結果與預期結果之間允許偏差的范圍。 4.4 進度進度 4.5 條件：給出項測試對資源的特殊要求，如設備、軟件、人條件：給出項測試對資源的特殊要求，如設備、軟件、人員等。員等。 4.6 測試資料：說明項測試所需的資料。測試資料：說明項

36、測試所需的資料。 5 評價評價 5.1 范圍：說明所完成的各項測試說明問題的范圍及其局限性。范圍：說明所完成的各項測試說明問題的范圍及其局限性。 5.2 準則：說明評論測試結果的準則。準則：說明評論測試結果的準則。 八、測試分析報告八、測試分析報告 1 引言引言 1.1 編寫目的：闡明編寫測試分析報告的目的并指明讀者對象。編寫目的：闡明編寫測試分析報告的目的并指明讀者對象。 1.2 項目背景：說明項目的來源、委托單位及主管部門。項目背景：說明項目的來源、委托單位及主管部門。 1.3定義：列出測試分析報告中所用到的專門術語的定義和縮定義：列出測試分析報告中所用到的專門術語的定義和縮寫詞的原意。寫

37、詞的原意。 1.4參考資料：列出有關資料的作者、標題、編號、發(fā)表日期、參考資料：列出有關資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：項目的計劃任務書、合同或出版單位或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；批文；項目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；詳細設計說明書；用戶操作手冊；測試計劃；測試分析報告詳細設計說明書；用戶操作手冊；測試計劃；測試分析報告所引用的其他資料、采用的軟件工程標準或工程規(guī)范。所引用的其他資料、采用的軟件工程標準或工程規(guī)范。 2 測試計劃招待情況測試計劃招待情況 2.1 機構和人員：給出測試機

38、構名稱、負責人和參與測試人員機構和人員：給出測試機構名稱、負責人和參與測試人員名單。名單。 2.2 測試結果：按順序給出每一測試項目的：實測結果數據；測試結果：按順序給出每一測試項目的：實測結果數據；與預期結果數據的偏差；該項測試表明的事實；該項測試發(fā)與預期結果數據的偏差；該項測試表明的事實；該項測試發(fā)現的問題?，F的問題。 3 軟件需求測試結論軟件需求測試結論 按順序給出每一項需求測試的結論。包括：證實的軟件能按順序給出每一項需求測試的結論。包括：證實的軟件能力；局限性（即項需求未得到充分測試的情況及原因。力；局限性（即項需求未得到充分測試的情況及原因。 4 評價評價 4.1 軟件能力：經過測

39、試所表明的軟件能力。軟件能力：經過測試所表明的軟件能力。 4.2 缺陷和限制：說明測試所揭露的軟件缺陷和不足，以及可缺陷和限制：說明測試所揭露的軟件缺陷和不足，以及可能給軟件運行帶來的影響。能給軟件運行帶來的影響。 4.3 建議：提出為彌補上述缺陷的建議。建議：提出為彌補上述缺陷的建議。 4.4 測試結論：說明能否通過。測試結論：說明能否通過。 九、開發(fā)進度月報九、開發(fā)進度月報 1 報告時間及所處的開發(fā)階段報告時間及所處的開發(fā)階段 2 工程進度工程進度 2.1 本月內的主要活動本月內的主要活動 2.2 實際進展與計劃比較實際進展與計劃比較 3 所用工時所用工時 按不同層次人員分別計時。按不同層

40、次人員分別計時。 4 所用機時所用機時 按所用計算機機型分別計時。按所用計算機機型分別計時。 5 經費支出經費支出 分類列出本月經費支出項目，給出支出總額，并與計劃比較。分類列出本月經費支出項目，給出支出總額，并與計劃比較。 6 工作遇到的問題及采取的對策工作遇到的問題及采取的對策 7 本月完成的成果本月完成的成果 8 下月的工作計劃下月的工作計劃 9 特殊問題特殊問題 十、項目開發(fā)總結報告十、項目開發(fā)總結報告 1 引言引言 1.1 編寫目的：闡明編寫總結報告的目的并指明讀者對象。編寫目的：闡明編寫總結報告的目的并指明讀者對象。 1.2 項目背景：說明項目的來源、委托單位、開發(fā)單位及主管項目背

41、景：說明項目的來源、委托單位、開發(fā)單位及主管部門。部門。 1.3 定義：列出報告中所用到的專門術語的定義和縮寫詞的原定義：列出報告中所用到的專門術語的定義和縮寫詞的原意。意。 1.4參考資料：列出有關資料的作者、標題、編號、發(fā)表日期、參考資料：列出有關資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：項目的計劃任務書、合同或出版單位或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；批文；項目開發(fā)計劃；需求規(guī)格說明書；概要設計說明書；詳細設計說明書；用戶操作手冊；測試計劃；測試分析報告；詳細設計說明書；用戶操作手冊；測試計劃；測試分析報告

42、；本報告引用的其他資料、采用的開發(fā)標準或開發(fā)規(guī)范。本報告引用的其他資料、采用的開發(fā)標準或開發(fā)規(guī)范。 2 開發(fā)結果開發(fā)結果 2.1 產品：可包括列出各部分的程序名稱、源程序行數（包括產品：可包括列出各部分的程序名稱、源程序行數（包括注釋行）或目標程序字節(jié)數及程序總計數量、存儲形式；產注釋行）或目標程序字節(jié)數及程序總計數量、存儲形式；產品文檔名稱等。品文檔名稱等。 2.2 主要功能及性能主要功能及性能 2.3 所用工時：按人員的不同層次分別計時。所用工時：按人員的不同層次分別計時。 2.4 所用機時：按所用計算機機型分別計時。所用機時：按所用計算機機型分別計時。 2.5 進度：給出計劃進度與實際進

43、度的對比。進度：給出計劃進度與實際進度的對比。 2.6 費用費用 3 評價評價 3.1 生產率評價：如平均每人每月生產的源程序行數、文檔的生產率評價：如平均每人每月生產的源程序行數、文檔的字數等。字數等。 3.2 技術方案評價技術方案評價 3.3 產品質量評價產品質量評價 4 經驗與教訓經驗與教訓 十一、軟件維護手冊十一、軟件維護手冊 1 引言引言 1.1 編寫目的：闡明編寫手冊的目的并指明讀者對象。編寫目的：闡明編寫手冊的目的并指明讀者對象。 1.2 項目背景：說明項目的提出者、開發(fā)者、用戶和使用場所。項目背景：說明項目的提出者、開發(fā)者、用戶和使用場所。 1.3 定義：列出報告中所用到的專門

44、術語的定義和縮寫詞的原定義：列出報告中所用到的專門術語的定義和縮寫詞的原意。意。 1.4 參考資料：列出有關資料的作者、標題、編號、發(fā)表日期、參考資料：列出有關資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，及保密級別，可包括：用戶操作手冊；出版單位或資料來源，及保密級別，可包括：用戶操作手冊；與本項目有關的其他文檔。與本項目有關的其他文檔。 2 系統(tǒng)說明系統(tǒng)說明 2.1 系統(tǒng)用途：說明系統(tǒng)具備的功能，輸入和輸出。系統(tǒng)用途：說明系統(tǒng)具備的功能，輸入和輸出。 2.2 安全保密：說明系統(tǒng)安全保密方面的考慮。安全保密：說明系統(tǒng)安全保密方面的考慮。 2.3 總體說明：說明系統(tǒng)的總體功能，對系統(tǒng)、

45、子系統(tǒng)和作業(yè)總體說明：說明系統(tǒng)的總體功能，對系統(tǒng)、子系統(tǒng)和作業(yè)做出綜合性的介紹，并用圖表的方式給出系統(tǒng)主要部分的內做出綜合性的介紹，并用圖表的方式給出系統(tǒng)主要部分的內部關系。部關系。2.4 程序說明：說明系統(tǒng)中每一程序、分程序的細節(jié)和特性。程序說明：說明系統(tǒng)中每一程序、分程序的細節(jié)和特性。 2.4.1 程序程序1的說明的說明 功能：說明程序的功能。功能：說明程序的功能。 方法：說明實現方法。方法：說明實現方法。 輸入：說明程序的輸入、媒體、運行數據記錄、運行開輸入：說明程序的輸入、媒體、運行數據記錄、運行開始時使用的輸入數據的類型和存放單元、與程序初始化有關始時使用的輸入數據的類型和存放單元、

46、與程序初始化有關的入口要求。的入口要求。 處理：處理特點和目的，如：用圖表說明程序的運行的處理：處理特點和目的，如：用圖表說明程序的運行的邏輯流程；程序主要轉移條件；對程序的約束條件；程序結邏輯流程；程序主要轉移條件；對程序的約束條件；程序結束時的出口要求；與下一個程序的通信與聯結（運行、控束時的出口要求；與下一個程序的通信與聯結（運行、控制）；由該程序產生并茶館處理程序段使用的輸出數據類型制）；由該程序產生并茶館處理程序段使用的輸出數據類型和存放單元；程序運行存儲量、類型及存儲位置等。和存放單元；程序運行存儲量、類型及存儲位置等。 輸出：程序的輸出。輸出：程序的輸出。 接口：本程序與本系統(tǒng)其

47、他部分的接口。接口：本程序與本系統(tǒng)其他部分的接口。 表格：說明程序內部的各種表、項的細節(jié)和特性。對每表格：說明程序內部的各種表、項的細節(jié)和特性。對每張表的說明至少包括：表的標識符；使用目的；使用此表的張表的說明至少包括：表的標識符；使用目的；使用此表的其他程序；邏輯劃分，如塊或部，不包括表項；表的基本結其他程序；邏輯劃分，如塊或部，不包括表項；表的基本結構；設計安排，包括表的控制信息。表目結構細節(jié)、使用中構；設計安排，包括表的控制信息。表目結構細節(jié)、使用中的特有性質及各表項的標識、位置、用途、類型、編碼表示。的特有性質及各表項的標識、位置、用途、類型、編碼表示。 特有的運行性質：說明在用戶操作

48、手冊中沒有提到的運特有的運行性質：說明在用戶操作手冊中沒有提到的運行性質。行性質。 2.4.2程序2的說明 與程序1的說明相同。以后的其他各程序的說明相同。 3 操作環(huán)境操作環(huán)境 3.1 設備：逐項說明系統(tǒng)的設備配置及其特性。設備：逐項說明系統(tǒng)的設備配置及其特性。 3.2 支持軟件：列出系統(tǒng)使用的支持軟件，包括它們的名稱和支持軟件：列出系統(tǒng)使用的支持軟件，包括它們的名稱和版本號。版本號。 3.3 數據庫：說明每個數據庫的性質和內容，包括安全考慮。數據庫：說明每個數據庫的性質和內容，包括安全考慮。 3.3.1總體特征：如標識符、使用這些數據庫的程序、靜態(tài)數據、總體特征：如標識符、使用這些數據庫的

49、程序、靜態(tài)數據、動態(tài)數據；數據庫的存儲媒體；程序使用數據庫的限制。動態(tài)數據；數據庫的存儲媒體；程序使用數據庫的限制。 3.3.2結構及詳細說明結構及詳細說明 說明該數據庫的結構，包括其中的記錄和項。說明該數據庫的結構，包括其中的記錄和項。 說明記錄的組成，包括首部或控制段、記錄體。說明記錄的組成，包括首部或控制段、記錄體。 說明每個記錄結構的字段，包括：標記或標號、字段的說明每個記錄結構的字段，包括：標記或標號、字段的字符長度和位數、該字段的允許值范圍。字符長度和位數、該字段的允許值范圍。 擴充：說明為記錄追加字段的規(guī)定。擴充：說明為記錄追加字段的規(guī)定。 4 維護過程維護過程 4.1 約定：列

50、出該軟件系統(tǒng)設計中所使用全部規(guī)則和約定，包約定：列出該軟件系統(tǒng)設計中所使用全部規(guī)則和約定，包括：程序、分程序、記錄、字段和存儲區(qū)的標識或標號助記括：程序、分程序、記錄、字段和存儲區(qū)的標識或標號助記符的使用規(guī)則；圖表的處理標準、卡片的連接順序、語句和符的使用規(guī)則；圖表的處理標準、卡片的連接順序、語句和記號中使用的縮寫、出現在圖表中的符號名；使用的軟件技記號中使用的縮寫、出現在圖表中的符號名；使用的軟件技術標準；標準化的數據元素及其特征。術標準；標準化的數據元素及其特征。 4.2 驗證過程：說明一個程序段修改后，對其進行驗證的要求驗證過程：說明一個程序段修改后，對其進行驗證的要求和過程（包括測試程

51、序和數據）及程序周期性驗證的過程。和過程（包括測試程序和數據）及程序周期性驗證的過程。 4.3 出錯及糾正方法：列出出錯狀態(tài)及其糾正方法。出錯及糾正方法：列出出錯狀態(tài)及其糾正方法。 4.4 專門維護過程：說明文檔其他地方沒有提到的專門維護過專門維護過程：說明文檔其他地方沒有提到的專門維護過程。如：維護該軟件系統(tǒng)的輸入輸出部分（如數據庫）的要程。如：維護該軟件系統(tǒng)的輸入輸出部分（如數據庫）的要求、過程和驗證方法；運行程序庫維護系統(tǒng)所必需的要求、求、過程和驗證方法；運行程序庫維護系統(tǒng)所必需的要求、過程和驗證方法；對閏年、世紀變更的所需要的臨時性修改過程和驗證方法；對閏年、世紀變更的所需要的臨時性修

52、改等。等。 4.5 專用維護程序：列出維護軟件系統(tǒng)使用的后備技術和專用專用維護程序：列出維護軟件系統(tǒng)使用的后備技術和專用程序（如文件恢復程序、淘汰過時文件的程序等）的目錄，程序（如文件恢復程序、淘汰過時文件的程序等）的目錄，并加以說明，內容包括：維護作業(yè)的輸入輸出要求；輸入的并加以說明，內容包括：維護作業(yè)的輸入輸出要求；輸入的詳細過程及在硬設備上建立、運行并完成維護作業(yè)的操作步詳細過程及在硬設備上建立、運行并完成維護作業(yè)的操作步驟。驟。 4.6 程序清單和流程圖：引用或提供附錄給出程序清單和流程程序清單和流程圖：引用或提供附錄給出程序清單和流程圖。圖。 十二、軟件問題報告十二、軟件問題報告 1

53、 登記號登記號 由軟件配置管理部門為該報告規(guī)定一個唯一的、順序的編由軟件配置管理部門為該報告規(guī)定一個唯一的、順序的編號。號。 2 登記日期登記日期 軟件配置管理部門登記該報告的日期。軟件配置管理部門登記該報告的日期。 3 問題發(fā)現日期問題發(fā)現日期 發(fā)現該問題的日期和時間。發(fā)現該問題的日期和時間。 4 活動活動 在哪個階段發(fā)現的問題，分為單元測試、組裝測試、確認在哪個階段發(fā)現的問題，分為單元測試、組裝測試、確認測試和運行維護。測試和運行維護。 5 狀態(tài)狀態(tài) 在軟件配置記錄中維護的動態(tài)指示，狀態(tài)表示有：正在復在軟件配置記錄中維護的動態(tài)指示，狀態(tài)表示有：正在復查查軟件問題報告軟件問題報告，以確定將采

54、取什么行動；，以確定將采取什么行動；軟件問題報軟件問題報告告已由指定的人去進行處理；修改已完成，并經過測試，已由指定的人去進行處理；修改已完成，并經過測試，正準備交給主程序庫；主程序庫已經更新，主程序庫修改的正準備交給主程序庫；主程序庫已經更新，主程序庫修改的重新測試沿未完成；做了重新測試，問題再現；做了重新測重新測試沿未完成；做了重新測試，問題再現；做了重新測試，所做的修改無故障，試，所做的修改無故障，軟件問題報告軟件問題報告被關閉；留待以后被關閉；留待以后關閉。關閉。 6 報告人報告人 填寫填寫軟件問題報告軟件問題報告人員的姓名、地址、電話。人員的姓名、地址、電話。 7 問題屬于什么方面問題屬于什么方面 區(qū)分是程序的問題，還是模塊的問題，或是數據庫的問題，區(qū)分是程序的問題，還是模塊的問題，或是數據庫的問題，文件的問題。也可能是它們的某種組合。文件的問題。也可能是它們的某種組合。 8 模