軟體工程文檔編寫标準（引）

  在項目開發過程中，應該按要求編寫好十三種文檔，文檔編制要求具有針對性、精确性、清晰性、完整性、靈活性、可追溯性。

　　◇ 可行性分析報告：說明該軟體開發項目的實作在技術上、經濟上和社會因素上的可行性，評述為了合理地達到開發目标可供選擇的各種可能實施方案，說明并論證所標明實施方案的理由。

　　◇ 項目開發計劃：為軟體項目實施方案制訂出具體計劃，應該包括各部分工作的負責人員、開發的進度、開發經費的預算、所需的硬體及軟體資源等。

　 　◇ 軟體需求說明書（軟體規格說明書）：對所開發軟體的功能、性能、使用者界面及運作環境等作出詳細的說明。它是在使用者與開發人員雙方對軟體需求取得共同了解并 達成協定的條件下編寫的，也是實施開發工作的基礎。該說明書應給出資料邏輯和資料采集的各項要求，為生成和維護系統資料檔案做好準備。

　　◇ 概要設計說明書：該說明書是概要實際階段的工作成果，它應說明功能配置設定、子產品劃分、程式的總體結構、輸入輸出以及接口設計、運作設計、資料結構設計和出錯處理設計等，為詳細設計提供基礎。

　　◇ 詳細設計說明書：着重描述每一子產品是怎樣實作的，包括實作算法、邏輯流程等。

　　◇ 使用者操作手冊：本手冊較長的描述軟體的功能、性能和使用者界面，使使用者對如何使用該軟體得到具體的了解,為操作人員提供該軟體各種運作情況的有關知識，特别是操作方法的具體細節。

　　◇ 測試計劃：為做好內建測試和驗收測試，需為如何組織測試制訂實施計劃。計劃應包括測試的内容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差範圍等。

　　◇ 測試分析報告：測試工作完成以後，應送出測試計劃執行情況的說明，對測試結果加以分析，并提出測試的結論意見。

　　◇ 開發進度月報：該月報系軟體人員按月向管理部門送出的項目進展情況報告，報告應包括進度計劃與實際執行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。

　　◇ 項目開發總結報告：軟體項目開發完成以後，應與項目實施計劃對照，總結實際執行的情況，如進度、成果、資源利用、成本和投入的人力，此外，還需對開發工作做出評價，總結出經驗和教訓。

　　◇ 軟體維護手冊：主要包括軟體系統說明、程式子產品說明、操作環境、支援軟體的說明、維護過程的說明，便于軟體的維護。

　　◇ 軟體問題報告：指出軟體問題的登記情況，如日期、發現人、狀态、問題所屬子產品等，為軟體修改提供準備文檔。

　　◇ 軟體修改報告：軟體産品投入運作以後，發現了需對其進行修正、更改等問題，應将存在的問題、修改的考慮以及修改的影響作出詳細的描述，送出審批。

項目開發計劃

1 引言

1.1 編寫目的：闡明編寫可行性研究報告的目的，提出讀者對象

1.2 項目背景：應包括

　　● 項目的委托機關、開發機關和主管部門；

　　● 該軟體系統與其他系統的關系。

1.3 定義：列出文檔中用到的專門術語的定義和縮寫詞的原文

1.4 參考資料：可包括：

　　● 項目經核準的計劃任務書、合同或上級機關的批文

　　● 文檔所引用的資料、規範等

　　● 列出這些資料的作者、标題、編号、發表日期、出版機關或資料來源；

2 項目概述

2.1 工作内容:簡要說明項目的各項主要工作，介紹所開發軟體的功能、性能等；若不編寫可行性研究報告；則應在本節給出較詳細的介紹；

2.2 條件與限制: 闡明為完成項目應具備的條件、開發機關已具備的條件以及尚需創造的條件。必要時還應說明使用者及分合同承擔的工作、完成期限及其他條件與限制。

2.3 産品

<chsdate year="1899" month="12" day="30" islunardate="False" isrocdate="False" w:st="on">2.3.1</chsdate>程式：列出應傳遞的程式名稱、使用的語言及存儲形式。

<chsdate year="1899" month="12" day="30" islunardate="False" isrocdate="False" w:st="on">2.3.2</chsdate>文檔：列出應傳遞的文檔。

2.4 運作環境：應包括硬體環境、軟體環境。

2.5 服務：闡明開發機關可向使用者提供的服務。如人員教育訓練、安裝、保修、維護和其他運作支援。

2.6 驗收标準

3 實施計劃

3.1 任務分解：任務的劃分及各項任務的負責人。

3.2 進度：按階段完成的項目，用圖表說明開始時間、完成時間。

3.3 預算

3.4 關鍵問題：說明可能影響項目的關鍵問題，如裝置條件、技術難點或其他風險因素，并說明對策。

4 人員組織及分工

5 傳遞期限

6 專題計劃要點

　　如測試計劃、品質保證計劃、配置管理計劃、人員教育訓練計劃、系統安裝計劃等。

軟體需求說明書

1 引言

1.1 編寫目的：闡明編寫需求說明書的目的，指明讀者對象。

1.2 項目背景：應包括

　　● 項目的委托機關、開心機關和主管部門；

　　● 該軟體系統與其他系統的關系。

1.3 定義：列出文檔中所用到的專門術語的定義和縮寫詞的願文。

1.4 參考資料：可包括

　　● 項目經核準的計劃任務書、合同或上級機關的批文

　　● 文檔所引用的資料、規範等

　　● 列出這些資料的作者、标題、編号、發表日期、出版機關或資料來源

2 任務概述

2.1 目标

2.2 運作環境

2.3 條件與限制

3 資料描述

3.1 表态資料

3.2 動态資料：包括輸入資料和輸出資料。

3.3 資料庫描述：給出使用資料庫的名稱和類型。

3.4 資料詞典

3.5 資料采集

4 功能需求

4.1功能劃分

4.2功能描述

5 性能需求

5.1 資料精确度

5.2 時間特性：如響應時間、更新處理時間、資料轉換與傳輸時間、運作時間等。

5.3 适應性：在操作方式、運作環境、與其他軟體的接口以及開發計劃等發生變化時，應具有的适應能力。

6 運作需求

6.1 使用者界面：如螢幕格式、報表格式、菜單格式、輸入輸出時間等。

6.2 硬體接口

6.3 軟體接口

6.4 故障處理

7 其他需求

　　如可使用性、安全保密、可維護性、可移植性等。

概要設計說明書

1 引言

1.1 寫目的：闡明編寫概要設計說明書的目的，指明讀者對象。

1.2 項目背景：應包括

　　● 項目的委托機關、開發機關和主管部門

　　● 該軟體系統與其他系統的關系。

1.3 定義：列出本文檔中所用到的專門術語的定義和縮寫詞的願意。

1.4 參考資料：

　　● 列出這些資料的作者、标題、編号、發表日期、出版機關或資料來源

　　●項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；測試計劃（初稿）；使用者操作手冊

　　● 文檔所引用的資料、采用的标準或規範。

2 任務概述

2.1 目标

2.2 需求概述

2.3 條件與限制

3 總體設計

3.2 總體結構和子產品外部設計

3.3 功能配置設定：表明各項功能與程式結構的關系。

4 接口設計

4.1 外部接口：包括使用者界面、軟體接口與硬體接口。

4.2 内部接口：子產品之間的接口。

5 資料結構設計

6 邏輯結構設計

　　所有文檔的統一封面格式如下頁所示。

7 實體結構設計

8 資料結構與程式的關系

9 運作設計

9.1 運作子產品的組合

9.2 運作控制

9.3 運作時間

10 出錯處理設計

10.1 出錯輸出資訊

10.2 出錯處理對策：如設定後備、性能降級、恢複及再啟動等。

11 安全保密設計

12 維護設計

　　說明為友善維護工作的設施，如維護子產品等。

詳細設計說明書

1 引言

1.1 編寫目的：闡明編寫詳細設計說明書的目的，指明讀者對象。

1.2 項目背景：應包括項目的來源和主管部門等。

1.3 定義：列出本文檔中所用到的專門術語的定義和縮寫詞的願意。

1.4 參考資料：

　　● 列出有關資料的作者、标題、編号、發表日期、出版機關或資料來源

　　●項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；概要設計說明書；測試計劃（初稿）；使用者操作手冊

　　● 文檔所引用的資料、軟體開發的标準或規範。

2 總體設計

2.1 需求概述

2.2 軟體結構：如給出軟體系統的結構圖。

3 程式描述

3.1 逐個子產品給出以下說明：

　　● 功能

　　● 性能

　　● 輸入項目

　　● 輸出項目

3.2 算法：子產品所選用的算法。

3.3 程式邏輯：較長的描述子產品實作的算法，可采用：标準流程圖；PDL語言；N-S圖；判定表等描述算法的圖表。

3.4 接口

　　● 存儲配置設定

　　● 限制條件

3.5測試要點：給出測試子產品的主要測試要求。

使用者操作手冊

1 引言

1.1 編寫目的：闡明編寫手冊的目的，指明讀者對象。

1.2 項目背景：說明項目的來源、委托機關、開發機關及和主管部門。

1.3 定義：列出手冊中使用的專門術語的定義和縮寫詞的願意。

1.4 參考資料：

　　● 列出有關資料的作者、标題、編号、發表日期、出版機關或資料來源

　　● 項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；測試計劃

　　● 文檔中所引用的其他資料、采用的軟體工程标準或軟體工程規範。

2 軟體概述

2.1 目标

2.2 功能

2.3 性能

2.4 資料精确度：包括輸入、輸出及處理資料的精度。

2.5 時間特性：如響應時間、處理時間、資料傳輸時間等。

2.6 靈活性：在操作方式、運作環境需做某些變更時軟體的适應能力。

3 運作環境

3.1 硬體

　　● 列出軟體系統運作時所需的硬體最小配置，如計算機型号、主存容量

　　● 外存儲器、媒體、記錄格式、裝置型号及數量

　　● 輸入、輸出裝置

　　● 資料傳輸裝置及資料轉換裝置的型号及數量。

3.2 支援軟體

　　● 作業系統名稱及版本号

　　● 語言編譯系統或彙編系統的名稱及版本号

　　● 資料庫管理系統的名稱及版本号

　　● 其他必要的支援軟體

4 使用說明

4.1 安裝和初始化：給出程式的存儲形式、操作指令、回報資訊及其做含意、表明安裝完成的測試執行個體以及安裝所需的軟體工具等。

4.2 輸入：給出輸入資料或參數的要求。

　　● 資料背景：說明資料來源、存儲媒體、出現頻度、限制和品質管理等。

　　● 資料格式:如長度、格式基準、标号、順序、分隔符、詞彙表、省略和重複、控制。

　　● 輸入舉例。

4.3 輸出：給出每項輸出資料的說明。

　　● 資料背景：說明輸出資料的去向、使用頻度、存放媒體及品質管理等。

　　● 資料格式：詳細闡明每一輸出資料的格式，如首部、主體和尾部的具體形式。

　　● 舉例

4.4 出錯和恢複：給出出錯資訊及其含意；使用者應采取的措施，如修改、恢複、再啟動。

4.5 查詢：說明如何操作。

5 運作說明

5.1 運作表：列出每種可能的運作情況，說明其運作目的。

5.2 運作步驟：按順序說明每和運作的步驟，應包括：

5.3 運作控制

5.4 操作資訊：運作目的、運作目的、操作要求、啟動方法、預計運作時間、操作指令格式及說明、其他事項；

5.5輸入/輸出檔案：給出建立或更新檔案的有關資訊，如：檔案的名稱及編号；記錄媒體；存留的目錄；檔案的支配：說明确定保留檔案或廢棄檔案的準則，分發檔案的對象，戰勝硬體的優先級及保密控制等。

5.6 啟動或恢複過程

6 非正常過程

　　提供應急戒非正常操作的必要資訊及操作步驟，如出錯處理操作、向後備系統切換操作及維護人員須知的操作和注意事項。

7 操作指令一覽表

　　按字母順序逐個列出全部操作指令的格式、功能及參數說明。

8 程式檔案（或指令檔案）和資料檔案一覽表

　　按檔案名字母順序或按功能與子產品分類順序逐個列出檔案名稱、辨別符及說明。

9 使用者操作舉例

測試計劃

1 引言

1.1 編寫目的：闡明編寫測試計劃的目的并指明讀者對象。

1.2 項目背景：說明項目的來源、委托機關及主管部門。

1.3 定義：列出測試 計劃中所用到的專門術語的定義和縮寫詞的原意。

1.4參考資料：列出有關資料的作者、标題、編号、發表日期、出版機關或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；使用者操作手冊；本測試計劃中引用的其他資料、采用

的軟體開發标準或規範。

2 任務概述

2.1 目标

2.2 運作環境

2.3 需求概述

2.4 條件與限制

3 計劃

3.1 測試方案：說明測試方法和選取測試用例的原則。

3.2 測試項目：列出組裝測試和确認測試中每一項測試的内容、名稱、目的和進度。

3.3 測試準備

3.4 測試機構及人員：測試機構名稱、負責人和職責。

4 測試項目說明

4.1 按順序逐個對測試項目做出說明

<chsdate year="1899" month="12" day="30" islunardate="False" isrocdate="False" w:st="on">4.1.1</chsdate> 測試項目名稱及測試内容

<chsdate year="1899" month="12" day="30" islunardate="False" isrocdate="False" w:st="on">4.1.2</chsdate> 測試用例

<chsdate year="1899" month="12" day="30" islunardate="False" isrocdate="False" w:st="on">4.1.3</chsdate> 輸入：輸入的資料和輸入指令。

<chsdate year="1899" month="12" day="30" islunardate="False" isrocdate="False" w:st="on">4.1.4</chsdate> 輸出：預期的輸出資料。

4.2 步驟及操作

4.3 允許偏差：給出實測結果與預期結果之間允許偏差的範圍。

4.4 進度

4.5 條件：給出項測試對資源的特殊要求，如裝置、軟體、人員等。

4.6 測試資料：說明項測試所需的資料。

5 評價

5.1 範圍：說明所完成的各項測試說明問題的範圍及其局限性。

5.2 準則：說明評論測試結果的準則。

測試分析報告

1 引言

1.1 編寫目的：闡明編寫測試分析報告的目的并指明讀者對象。

1.2 項目背景：說明項目的來源、委托機關及主管部門。

1.3定義：列出測試分析報告中所用到的專門術語的定義和縮寫詞的原意。

1.4參考資料：列出有關資料的作者、标題、編号、發表日期、出版機關或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；使用者操作手冊；測試計劃；測試分析報告所引用的其他資料、采用的軟體工程标準或工程規範。

2 測試計劃招待情況

2.1 機構和人員：給出測試機構名稱、負責人和參與測試人員名單。

2.2 測試結果：按順序給出每一測試項目的：實測結果資料；與預期結果資料的偏差；該項測試表明的事實；該項測試發現的問題。

3 軟體需求測試結論

　　按順序給出每一項需求測試的結論。包括：證明的軟體能力；局限性（即項需求未得到充分測試的情況及原因。

4 評價

4.1 軟體能力：經過測試所表明的軟體能力。

4.2 缺陷和限制：說明測試所揭露的軟體缺陷和不足，以及可能給軟體運作帶來的影響。

4.3 建議：提出為彌補上述缺陷的建議。

4.4 測試結論：說明能否通過。

開發進度月報

1 報告時間及所處的開發階段

2 工程進度

2.1 本月内的主要活動

2.2 實際進展與計劃比較

3 所用工時

　　按不同層次人員分别計時。</fo>