軟件開發(fā)設計 模板

《軟件開發(fā)設計 模板》由會員分享，可在線閱讀，更多相關《軟件開發(fā)設計 模板（10頁珍藏版）》請在裝配圖網上搜索。

1、軟件文檔編寫指南 封面格式： 文檔編號 編寫 文檔名稱： 項目名稱： 項目負責人： 版本號 年 月 日 校對 年 月 日 審核 年 月 日 批準 年 月 日 開發(fā)單位 系統(tǒng)規(guī)約說明書（System Specification ） 一．引言 A. 文檔的范圍和目的 B. 概述 1．目標 2．約束 二．功能和數據描述 A. 系統(tǒng)結構 1．結構關系圖 2．結構關系圖描述 三．子系統(tǒng)描述 A. 子系統(tǒng)N的結構圖規(guī)約說明 B. 結構字典 C. 結構連接圖和說明 四．系統(tǒng)建模和模擬結構 A. 用于模擬的系統(tǒng)模型

2、 B. 模擬結果 C. 特殊性能 五．軟件項目問題 A. 軟件項目可行性研究報告 B. 軟件項目計劃 六．附錄 軟件項目可行性研究報告（ Report for Feasibility Study） 一．引言 1．編寫目的（闡明編寫可行性研究報告的目的，指出讀者對象） 2．項目背景（應包括：（1）所建議開發(fā)的軟件名稱；（2）項目的任務提出者、開發(fā)者 用戶及實現單位；（3）項目與其他軟件或其他系統(tǒng)的關系。） 3．定義（列出文檔中用到的專門術語的定義和縮略詞的原文。） 4．參考資料（列出有關資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源。） 二．可行性研究的前提 1．

3、要求（列出并說明建議開發(fā)軟件的基本要求，如（1）功能；（2）性能；（3）輸出；（4） 輸入；（5）基本的數據流程和處理流程；（6）安全與保密要求；（7）與軟件相關的其 他系統(tǒng)；（8）完成期限。） 2．目標（可包括：（1）人力與設備費用的節(jié)??；（2）處理速度的提高；（3）控制精度和 生產能力的提高；（4）管理信息服務的改進；（5）決策系統(tǒng)的改進；（6）人員工作效 率的提高，等等。） 3．條件、假定和限制（可包括：（1）建議開發(fā)軟件運行的最短壽命；（2）進行系統(tǒng)方案 選擇比較的期限；（3）經費來源和使用限制；（4）法律和政策方面的限制；（5）硬件、 軟件、運行環(huán)境和開發(fā)環(huán)境的條件和限制；（6）

4、可利用的信息和資源；（7）建議開發(fā) 軟件投入使用的最遲時間。） 4．可行性研究方法 5． 決定可行性的主要因素 三．對現有系統(tǒng)的分析 1．處理流程和數據流程 2．工作負荷 3．費用支出（如人力、設備、空間、支持性服務、材料等項開支。） 4．人員（列出所需人員的專業(yè)技術類別和數量。） 5．設備 6．局限性（說明現有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng)。） 四．所建議技術可行性分析 1．對系統(tǒng)的簡要描述 2．處理流程和數據流程 3．與現有系統(tǒng)比較的優(yōu)越性 4．采用建議系統(tǒng)可能帶來的影響 （1）對設備的影響 （2）對現有軟件的影響 （3）對用戶的影響 （4）對

5、系統(tǒng)運行的影響 （5）對開發(fā)環(huán)境的影響 （6）對運行環(huán)境的影響 （7）對經費支出的影響 5．技術可行性評價（包括：（1）在限制條件下，功能目標是否能夠達到；（2）利用現有 技術，功能目標能否達到；（3）對開發(fā)人員數量和質量的要求，并說明能否滿足；（4） 在規(guī)定的期限內，開發(fā)能否完成。） 五．所建議系統(tǒng)經濟可行性分析 1．指出 （1）基建投資 （2）其他一次性支出 （3）經常性支出 2．效益 （1）一次性收益 （2）經常性收益 （3）不可定量收益 3．收益/投資比 4．投資回收周期 5．敏感性分析（指一些關鍵性因素，如：系統(tǒng)生存周期長短、系統(tǒng)工作負荷量、處理速 度

6、要求、設備和軟件配置變化對支出和效益的影響等的分析。） 六．社會因素可行性分析 1．法律因素（如，合同責任、侵犯專利權、侵犯版權等問題的分析。） 2．用戶使用可行性（如，用戶單位的行政管理、工作制度、人員素質等能否滿足要求。） 七．其他可供選擇的方案（逐個闡明其他可供選擇的方案，并重點說明未被推薦的理由。） 八．結論意見（可能是：（1）可著手組織開發(fā)；（2）需待若干條件（如資金、人力設備等） 具備后才能開發(fā)；（3）需對開發(fā)目標進行某些修改；（4）不能進行或不必進行（如技術 不成熟，經濟上不合算等）；（4）其他。） 軟件項目計劃（Software Project Plan） 一．引言

7、1．編寫目的（闡明編寫軟件計劃的目的，指出讀者對象。） 2．項目背景（可包括：（1）項目委托單位、開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其 他系統(tǒng)的關系。） 3．定義（列出本文檔中用到的專門術語的定義和縮略詞的原文。） 4．參考資料（可包括：（1）項目經核準的計劃任務書、合同或上級機關的批文；（2）文 檔所引用的資料、規(guī)范等；列出資料的作者、標題、編號、發(fā)表日期、出版單位或資 料來源。） 二．項目概述 1. 工作內容（簡要說明項目的各項主要工作,介紹所開發(fā)軟件的功能 性能等. 若不編寫可 行性研究報告,則應在本節(jié)給出較詳細的介紹。） 2. 條件與限制（闡明為完成項目應具備的條件 開發(fā)

8、單位已具備的條件以及尚需創(chuàng)造的條 件. 必要時還應說明用戶及分合同承包者承擔的工作 完成期限及其它條件與限制。） 3. 產品 （1）程序（列出應交付的程序名稱 使用的語言及存儲形式。） （2）文檔（列出應交付的文檔。） （3）運行環(huán)境（應包括硬件環(huán)境 軟件環(huán)境。） 4．服務（闡明開發(fā)單位可向用戶提供的服務. 如人員培訓 安裝 保修 維護和其他運行支 持。） 5．驗收標準 三．實施計劃 1．任務分解（任務的劃分及各項任務的負責人。） 2．進度（按階段完成的項目,用圖表說明開始時間 完成時間。） 3．預算 4．關鍵問題（說明可能影響項目的關鍵問題,如設備條件 技術難點或其他風

9、險因素,并說 明對策。） 四．人員組織及分工 五．交付期限 六．專題計劃要點（如測試計劃 質量保證計劃 配置管理計劃 人員培訓計劃 系統(tǒng)安裝計劃 等。） 需求規(guī)格說明書（Requirements Specification ） 一．引言 1．編寫目的（闡明編寫需求說明書的目的,指明讀者對象。） 2．項目背景（可包括：（1）項目的委托單位,開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其 他系統(tǒng)的關系。） 3．定義（列出文檔中用到的專門術語定義和縮寫詞的原文。） 4．參考資料（可包括：（1）項目經核準的計劃任務書,合同或上機機關的批文；（2）項目 開發(fā)計劃；（3）文檔所引用的資料，

10、標準和規(guī)范。列出這些資料的作者、標題、編號、 發(fā)表日期、出版單位或資料來源。） 二．任務概述 1．目標 2．運行環(huán)境 3．條件與限制 三．數據描述 1． 靜態(tài)數據 2．動態(tài)數據（包括輸入數據和輸出數據。） 3．數據庫描述（給出使用數據庫的名稱和類型。） 4．數據詞典 5． 數據采集 四．功能需求 1．功能劃分 2．功能描述 五．性能需求 1．數據精確度 2．時間特性（如響應時間、更新處理時間、數據轉化與傳輸時間、運行時間等。） 3．適應性（在操作方式 運行環(huán)境 與其他軟件的接口以及開發(fā)計劃等發(fā)生變化時，應具 有的適應能力。） 六．運行需求 1．用戶界面（如

11、屏幕格式、報表格式、菜單格式、輸入輸出時間等。） 2．硬件接口 3．軟件接口 4．故障處理 七．其他需求（如可使用性、安全保密、可維護性、可移植性等。） 概要設計說明書（ Architectural Design Specification） 一．引言 1．編寫目的（闡明編寫概要設計說明書的目的，指明讀者對象。） 2．項目背景（可包括：（1）項目的委托單位,開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其 他系統(tǒng)的關系。） 3．定義（列出文檔中用到的專門術語定義和縮寫詞的原意。） 4．參考資料（列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可 包括：（1）項目經核準的

12、計劃任務書，合同或上機機關的批文；（2）項目開發(fā)計劃； （3）需求規(guī)格說明書；（4）測試計劃（初稿）；（5）用戶操作手冊（初稿）；（6）文檔 所引用的資料、采用的標準或規(guī)范。） 二．任務概述 1．目標 2．運行環(huán)境 3．需求概述 4．條件與限制 三．總體設計 1．處理流程 2．總體結構和模塊外部設計 3．功能分配（表明各項功能與程序結構的關系。） 四．接口設計 1．外部接口（包括用戶界面 軟件接口與硬件接口。） 2．內部接口（模塊之間的接口。） 五．數據結構設計 1．邏輯結構設計 2． 物理結構設計 3．數據結構與程序的關系 六．運行設計 1．運行模塊的組

13、合 2．運行控制 3．運行時間 七．出錯處理設計 1．出錯輸出信息 2．出錯處理對策（如設置后備、性能降級、恢復及再啟動等。） 八．安全保密設計 九．維護設計（說明為方便維護工作的設施,如維護模塊等。） 詳細設計說明書（Procedural Design Specification ） 一．引言 1．編寫目的（闡明編寫詳細設計說明書的目的,指明讀者對象。） 2．項目背景（應包括項目的來源和主管部門等。） 3．定義（列出文檔中用到的專門術語定義和縮寫詞的原意。） 4．參考資料（列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可 包括：（1）項目的計劃任務書

14、,合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明書； （3）概要設計說明書；（4）測試計劃（初稿）；（5）用戶操作手冊（初稿）；（5）文檔所 引用的其他資料、軟件開發(fā)標準或規(guī)范。） 二．總體設計 1．需求概述 2．軟件結構（如給出軟件系統(tǒng)的結果圖。） 三．程序描述（逐個模塊給出以下的說明:：） 1．功能 2．性能 3．輸入項目 4．輸出項目 5．算法（模塊所選用的算法。） 6.程序邏輯（詳細描述模塊實現的算法，可采用:：（1）標準流程圖；（2）PDL語言；（3） N-S圖；（4） PAD；（5）判定表等描述算法的圖表。 7．接口 8．存儲分配 9．限制條件 1

15、0． 測試要點（給出測試模塊的主要測試要求。） 用戶操作手冊（User Guide） 一．引言 1 ．編寫目的（闡明編寫手冊的目的，指明讀者對象。） 2．項目背景（說明項目的來源、委托單位、開發(fā)單位及主管部門。） 3．定義（列出手冊中用到的專門術語定義和縮寫詞的原意。） 4．參考資料（列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可 包括：（1）項目的計劃任務書,合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明書； （4）概要設計說明書；（5）詳細設計說明書；（6）測試計劃；（7）手冊中引用的其他 資料、采用的軟件工程標準或軟件工程規(guī)范。） 二．軟件概述 1

16、 ．目標 2．功能 3．性能 （ 1 ）數據精確度（包括輸入、輸出及處理數據的精度。） （ 2）時間特性（如響應時間、處理時間、數據傳輸時間等。） （3）靈活性（在操作方式、運行環(huán)境需做某些變更時軟件的適應能力。） 三．運行環(huán)境 1 ．硬件（列出軟件系統(tǒng)運行時所需的硬件最小配置，如：（ 1 ）計算機型號、主存容量； （2）外存儲器、媒體、記錄格式、設備型號及數量；（3）輸入、輸出設備；（4）數據 傳輸設備及數據轉換設備的型號及數量。） 2．支持軟件（如：（1）操作系統(tǒng)名稱及版本號；（2）語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及 版本號；（3）數據庫管理系統(tǒng)的名稱及版本號；（4）其他必要的

17、支持軟件。） 四．使用說明 1．安裝和初始化（給出程序的存儲形式、操作命令、反饋信息及其含義、表明安裝完成 的測試實例以及安裝所需的軟件工具等。） 2．輸入（給出輸入數據或參數的要求。） （ 1）數據背景（說明數據來源、存儲媒體、出現頻度、限制和質量管理等。） （ 2）數據格式（如：（ 1）長度（ 2）格式基準（ 3）標號（ 4）順序（ 5）分隔符（ 6） 詞匯表（ 7）省略和重復（ 8）控制。） （ 3 ）輸入舉例 3．輸出（給出每項輸出數據的說明。） （1） 數據背景（說明輸出數據的去向、使用頻度、存放媒體及質量管理等。） （2） 數據格式（詳細闡明每一輸出數據的格式,

18、如:首部 主體和尾部的具體形式。） （ 3 ）舉例 3．出錯和恢復（給出：（1）出錯信息及其含義（2）用戶應采取的措施，如修改、恢復、 再啟動。） 4．求助查詢（說明如何操作。） 五．運行說明 1． 運行表 ［列出每種可能的運行情況,說明其運行目的.］ 2． 運行步驟 ［按順序說明每種運行的步驟,應包括:］ （1） 運行控制 （2） 操作信息（（1）運行目的（2）操作要求（3）啟動方法（4）預計運行時間（5） 操作命令格式及說明（6）其他事項。） （3） 輸入/輸出文件（給出建立和更新文件的有關信息，如：（1）文件的名稱及編 號（2）記錄媒體（3）存留的目錄（4）文件的支配

19、［說明確定保留文件或廢棄 文件的準則，分發(fā)文件的對象，占用硬件的優(yōu)先級及保密控制等。） （4） 啟動或恢復過程 六．非常規(guī)過程（提供應急或非常規(guī)操作的必要信息及操作步驟，如出錯處理操作、向后備 系統(tǒng)切換操作以及維護人員須知的操作和注意事項。） 七．操作命令一覽表 （按字母順序逐個列出全部操作命令的格式 功能及參數說明。） 八．程序文件（或命令文件）和數據文件一覽表（按文件名字母順序或按功能與模塊分類順 序逐個列出文件名稱、標識符及說明。） 九．用戶操作舉例 測試計劃（Test Plan） 一、引言 1．編寫目的（闡明編寫測試計劃的目的,指明讀者對象。） 2． 項目背景（說明項目

20、的來源 委托單位及主管部門。） 3．定義（列出測試計劃中用到的專門術語定義和縮寫詞的原意。） 4．參考資料（列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可 包括：（1）項目的計劃任務書，合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明 書；（3）概要設計說明書；（4）詳細設計說明書；（5）用戶操作手冊;g本測試計劃中 引用的其他資料 采用的軟件開發(fā)標準或規(guī)范。） 二．任務概述 1．目標 2．運行環(huán)境 3．需求概述 4．條件與限制 三．計劃 1．測試方案（說明確定測試方法和選取測試用例的原則。） 2．測試項目（列出組裝測試和確認測試中每一項測試的內容、名稱、

21、目的和進度。） 3．測試準備 4．測試機構及人員（測試機構名稱 負責人和職責。） 四．測試項目說明（按順序逐個對測試項目做出說明：） 1．測試項目名稱及測試內容 2．測試用例 （1）輸入（輸入的數據和輸入的命令。） （2）輸出（預期的輸出數據。） （3）步驟及操作 （4）允許偏差（給出實測結果與預測結果之間允許偏差的范圍。） 3．進度 4．條件（給出項測試對資源的特殊要求，如設備、軟件、人員等。） 5．測試資料（說明項測試所需的資料。） 五．評價 1．范圍（說明所完成的各項測試說明問題的范圍及其局限性。） 2．準則（說明評價測試結果的準則。） 測試分析報告（Test

22、 Specification） 一．引言 1．編寫目的（闡明編寫測試分析報告的目的，指明讀者對象。） 2．項目背景（說明項目的來源、委托單位及主管部門。） 3．定義（列出測試分析報告中用到的專門術語定義和縮寫詞的原意。） 4．參考資料（列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可 包括：（1）項目的計劃任務書，合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明 書；（4）概要設計說明書；（5）詳細設計說明書；（6）用戶操作手冊；（7）測試計劃； （8）測試分析報告所引用的其他資料、采用的軟件工程標準或軟件工程規(guī)范。） 二．測試計劃執(zhí)行情況 1．測試項目（列出每一

23、測試項目的名稱、內容和目的。） 2．測試機構和人員（給出測試機構名稱、負責人和參與測試人員名單。） 3．測試結果（按順序給出每一測試項目的：（1）實測結果數據（2）與預期結果數據的偏 差（3）該項測試說明的事實（4）該項測試發(fā)現的問題。） 三．軟件需求測試結論（按順序給出每一項需求測試的結論。包括：（1）證實的軟件能力（2） 局限性（即項需求未得到充分測試的情況及原因）。） 四．評價 1．軟件能力（經過測試所表明的軟件能力。） 2．缺陷和限制（說明測試所揭露的軟件缺陷和不足,以及可能給軟件運行帶來的影響。） 3．建議（提出為彌補上述缺陷的建議。） 4．測試結論（說明能否通過。）

24、 開發(fā)進度月報 一．報告時間及所處的開發(fā)階段 二．給出進度 1． 本月內的主要活動 2． 實際進展與計劃比較 三．所用工時（按不同層次人員分別計時。） 四．所有機時（按所有計算機機型分別計時。） 五．經費支出（分類列出本月經費支出項目,給出支出總額，并與計劃比較。） 六．工作遇到的問題及采取的對策 七．本月完成的成果 八．下月的工作計劃 九．特殊問題 項目開發(fā)總結報告 ．引言 1．編寫目的（闡明編寫總結報告的目的,指明讀者對象。） 2．項目背景（說明項目的來源、委托單位、開發(fā)單位及主管部門。） 3．定義（列出報告中用到的專門術語定義和縮寫詞的原意。） 4．參考資料（列出這

25、些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可 包括：（1）項目的計劃任務書，合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明 書；（4）概要設計說明書；（5）詳細設計說明書；（6）用戶操作手冊；（7）測試計劃； （8）測試分析報告（9）本報告引用的其他資料、采用的開發(fā)標準或開發(fā)規(guī)范。） 二．開發(fā)結果 1．產品（可包括：（1）列出各部分的程序名稱、源程序行數（包括注釋行）或目標程序 字節(jié)數及程序總計數量、存儲形式；產品文檔名稱等。） 2． 主要功能及性能 3．所用工時（按人員的不同層次分別計時。） 4．所用機時（按所用計算機機型分別計時。） 5．進度（給出計劃進度與實際進

26、度的對比。） 6．費用 三．評價 1．生產率評價（如平均每人每月生產的源程序行數、文檔的字數等。） 2．技術方案評價 3．產品質量評價 四．經驗與教訓 軟件修改報告 一．登記號（由軟件配置管理部門為該報告規(guī)定的編號。） 二．登記日期（軟件配置管理部門登記”軟件修改報告”的日期。） 三．時間（準備好”軟件修改報告”的日期。） 四．報告人（填寫該報告的作者。） 五．子系統(tǒng)名（受修改影響的子系統(tǒng)名。） 六．模塊名（被修改的模塊名。） 七．“軟件問題報告”的編號（被”軟件修改報告”處理或部分處理的”軟件問題報告”的編號。） 八．修改（包括程序修改、文件更新、數據庫修改或他們的組合。）

27、九．修改描述（修改的詳細描述。如果是文件更新或數據庫修改，還要列出文件更新通知或 數據庫修改申請的標識符。） 十．批準人（批準人簽字，正式批準進行修改。） 十一． 語句類型（程序修改中涉及到的語句類型，包括：輸入/輸出語句類、計算語句類、 邏輯控制語句類、數據處理語句類（如數據傳送 存取語句類）。） 十二． 程序名（被修改的程序、文件或數據庫名字。） 十三． 老修訂版（當前的版本/修訂本標識。） 十四． 新修訂版（修改后的版本/修訂本標識。） 十五． 數據庫（如果申請數據庫修改,則給出數據庫的標識符。） 十六． 數據庫修改報告（數據庫修改申請?zhí)?。? 十七． 文件（如果要求對文件進行修改，則給出文件的名字。） 十八． 文件更新（文件更新通知單的編號。） 十九． 修改是否已測試（指出已對修改做了哪些測試，如單元、子系統(tǒng)、組裝、確認和運 行測試等，并注明測試成功與否。） 二十． “軟件問題報告”是否給出問題的準確描述 二十一．問題注釋（準確地敘述要維護的問題。） 二十二．問題源（指明問題來自于哪里。） 二十三．資源（完成修改所需資源的估計，即總的人時數和計算機時間的開銷。）