1、.附2:軟件文檔編寫向導文檔分類項目包括如下幾類文檔：項目管理文檔。包括：軟件項目計劃、項目進度報告、項目開發(fā)總結報告軟件開發(fā)文檔。包括：需求規(guī)格說明、概要設計說明、詳細設計說明、測試計劃、軟件測試分析報告。產(chǎn)品文檔。包括：用戶操作手冊演示文件。軟件項目計劃（Software Project Plan）一引言1編寫目的（闡明編寫軟件計劃的目的，指出讀者對象。）2項目背景（可包括：（1）項目委托單位、開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關系。）3定義（列出本文檔中用到的專門術語的定義和縮略詞的原文。）4參考資料（可包括：文檔所引用的資料、規(guī)范等；列出資料的作者、標題、編號、發(fā)表日期、

2、出版單位或資料來源。）二項目概述1.    工作內(nèi)容（簡要說明項目的各項主要工作,介紹所開發(fā)軟件的功能性能等. 若不編寫可行性研究報告,則應在本節(jié)給出較詳細的介紹。)2.    條件與限制（闡明為完成項目應具備的條件開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件. 必要時還應說明用戶及分合同承包者承擔的工作完成期限及其它條件與限制。）3.    產(chǎn)品   （1）程序（列出應交付的程序名稱使用的語言及存儲形式。）     （2）文檔（列出應交付的文檔。）&

3、#160;    （3）運行環(huán)境（應包括硬件環(huán)境軟件環(huán)境。）4服務（闡明開發(fā)單位可向用戶提供的服務. 如人員培訓安裝保修維護和其他運行支持。）5驗收標準三實施計劃1任務分解（任務的劃分及各項任務的負責人。）2進度（按階段完成的項目,用圖表說明開始時間完成時間。）3預算4關鍵問題（說明可能影響項目的關鍵問題,如設備條件技術難點或其他風險因素,并說明對策。）四人員組織及分工五交付期限六專題計劃要點（如測試計劃等。）項目開發(fā)進度報告一報告時間及所處的開發(fā)階段二給出進度1 本周的主要活動2 實際進展與計劃比較三所用工時（按不同層次人員分別計時。）四所有

4、機時五工作遇到的問題及采取的對策六本周完成的成果七下周的工作計劃八特殊問題項目開發(fā)總結報告一引言1編寫目的（闡明編寫總結報告的目的,指明讀者對象。）2項目背景（說明項目的來源、委托單位、開發(fā)單位及主管部門。）3定義（列出報告中用到的專門術語定義和縮寫詞的原意。）4參考資料（列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目開發(fā)計劃；（2）需求規(guī)格說明書；（3）概要設計說明書；（4）詳細設計說明書；（5）用戶操作手冊；（6）測試計劃；（7）測試分析報告（8）本報告引用的其他資料、采用的開發(fā)標準或開發(fā)規(guī)范。）二開發(fā)結果1 產(chǎn)品（可包括：（1）列出各部分的程序

5、名稱、源程序行數(shù)（包括注釋行）或目標程序字節(jié)數(shù)及程序總計數(shù)量、存儲形式；產(chǎn)品文檔名稱等。）2 主要功能及性能3 所用工時（按人員的不同層次分別計時。）4 所用機時5 進度（給出計劃進度與實際進度的對比。）三評價1生產(chǎn)率評價（如平均每人每周源程序行數(shù)、文檔的字數(shù)等。）2技術方案評價3產(chǎn)品質(zhì)量評價四經(jīng)驗與教訓 需求規(guī)格說明書（Requirements Specification）一引言1 編寫目的（闡明編寫需求說明書的目的,指明讀者對象。）2 項目背景（可包括：（1）項目的委托單位,開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)

6、的關系。）3 定義（列出文檔中用到的專門術語定義和縮寫詞的原文。）4 參考資料（可包括：（1）項目開發(fā)計劃；（2）文檔所引用的資料，標準和規(guī)范。列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源。）二任務概述1目標2運行環(huán)境3條件與限制三數(shù)據(jù)描述1 靜態(tài)數(shù)據(jù)2 動態(tài)數(shù)據(jù)（包括輸入數(shù)據(jù)和輸出數(shù)據(jù)。）3 數(shù)據(jù)庫描述（給出使用數(shù)據(jù)庫的名稱和類型。）4 數(shù)據(jù)詞典5 數(shù)據(jù)采集四功能需求1功能劃分2功能描述五性能需求1數(shù)據(jù)精確度2時間特性（如響應時間、更新處理時間、數(shù)據(jù)轉化與傳輸時間、運行時間等。）3適應性（在操作方式運行環(huán)境

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

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

9、備、性能降級、恢復及再啟動等。）八安全保密設計九維護設計（說明為方便維護工作的設施,如維護模塊等。）詳細設計說明書（Procedural Design Specification）一引言1 編寫目的（闡明編寫詳細設計說明書的目的,指明讀者對象。）2 項目背景（應包括項目的來源和主管部門等。）3 定義（列出文檔中用到的專門術語定義和縮寫詞的原意。）4 參考資料（列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目開發(fā)計劃；（2）需求規(guī)格說明書；（3）概要設計說明書；（4）測試計劃(初稿)；（5）用戶操作手冊(初稿)；（5）文檔所

10、引用的其他資料、軟件開發(fā)標準或規(guī)范。）二總體設計1需求概述2軟件結構（如給出軟件系統(tǒng)的結果圖。）三程序描述（逐個模塊給出以下的說明:：）1功能2性能3輸入項目4輸出項目5算法（模塊所選用的算法。）6程序邏輯（詳細描述模塊實現(xiàn)的算法，可采用:：（1）標準流程圖；（2）N-S圖；（3）PAD；（4）判定表等描述算法的圖表。）7接口8存儲分配9限制條件10測試要點（給出測試模塊的主要測試要求。）測試計劃（Test Plan）一、引言1 編寫目的（闡明編寫測試計劃的目的,指明讀者對象。）2 項目背景（說明項目的來源委托單位及主管部門。）3 定義（列出測試計劃中用到的專門術

11、語定義和縮寫詞的原意。）4 參考資料（列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目開發(fā)計劃；（2）需求規(guī)格說明書；（3）概要設計說明書；（4）詳細設計說明書；（5）用戶操作手冊; (6) 本測試計劃中引用的其他資料采用的軟件開發(fā)標準或規(guī)范。）二任務概述1目標2運行環(huán)境3需求概述4條件與限制三計劃 1測試方案（說明確定測試方法和選取測試用例的原則。） 2測試項目（列出組裝測試和確認測試中每一項測試的內(nèi)容、名稱、目的和進度。） 3測試準備 4測試機構及人員（測試機構名稱負責人和職責。）四測試項目說明（按順序逐個對

12、測試項目做出說明：） 1測試項目名稱及測試內(nèi)容 2測試用例（1）輸入（輸入的數(shù)據(jù)和輸入的命令。）（2）輸出（預期的輸出數(shù)據(jù)。） （3）步驟及操作（4）允許偏差（給出實測結果與預測結果之間允許偏差的范圍。）3 進度4 條件（給出項測試對資源的特殊要求，如設備、軟件、人員等。）5 測試資料（說明項測試所需的資料。）五評價1范圍（說明所完成的各項測試說明問題的范圍及其局限性。）2準則（說明評價測試結果的準則。） 測試分析報告（Test Specification）一引言1編寫目的（闡明編寫測試分析報告的目的，指明讀者對象。）2項目

13、背景（說明項目的來源、委托單位及主管部門。）3定義（列出測試分析報告中用到的專門術語定義和縮寫詞的原意。）4參考資料（列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目開發(fā)計劃；（2）需求規(guī)格說明書；（3）概要設計說明書；（4）詳細設計說明書；（5）用戶操作手冊；（6）測試計劃；（7）測試分析報告所引用的其他資料、采用的軟件工程標準或軟件工程規(guī)范。）二測試計劃執(zhí)行情況1測試項目（列出每一測試項目的名稱、內(nèi)容和目的。）2測試機構和人員（給出測試機構名稱、負責人和參與測試人員名單。）3測試結果（按順序給出每一測試項目的：（1）實測結果數(shù)據(jù)（2）與預期結果數(shù)據(jù)的偏差（3

14、）該項測試說明的事實（4）該項測試發(fā)現(xiàn)的問題。）三軟件需求測試結論按順序給出每一項需求測試的結論。包括：（1）證實的軟件能力（2）局限性（即項需求未得到充分測試的情況及原因）。四評價1軟件能力（經(jīng)過測試所表明的軟件能力。）2缺陷和限制（說明測試所揭露的軟件缺陷和不足,以及可能給軟件運行帶來的影響。）3建議（提出為彌補上述缺陷的建議。）4測試結論（說明能否通過。）用戶操作手冊（User Guide）一引言1編寫目的（闡明編寫手冊的目的，指明讀者對象。）2項目背景（說明項目的來源、委托單位、開發(fā)單位及主管部門。）3定義（列出手冊中用到的專門術語定義和縮寫詞的原意。）4參考資料（列出這些資料的作者、

15、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目開發(fā)計劃；（2）需求規(guī)格說明書；（3）概要設計說明書；（4）詳細設計說明書；（5）測試計劃；（6）手冊中引用的其他資料、采用的軟件工程標準或軟件工程規(guī)范。）二軟件概述1目標2功能3性能（1）數(shù)據(jù)精確度（包括輸入、輸出及處理數(shù)據(jù)的精度。）（2）時間特性（如響應時間、處理時間、數(shù)據(jù)傳輸時間等。）（3）靈活性（在操作方式、運行環(huán)境需做某些變更時軟件的適應能力。）三運行環(huán)境1硬件（列出軟件系統(tǒng)運行時所需的硬件最小配置，如：（1）計算機型號、主存容量；（2）外存儲器、媒體、記錄格式、設備型號及數(shù)量；（3）輸入、輸出設備；（4）數(shù)據(jù)傳輸設備及數(shù)據(jù)

16、轉換設備的型號及數(shù)量。）2支持軟件（如：（1）操作系統(tǒng)名稱及版本號；（2）語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號；（3）數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號；（4）其他必要的支持軟件。）四使用說明1安裝和初始化（給出程序的存儲形式、操作命令、反饋信息及其含義、表明安裝完成的測試實例以及安裝所需的軟件工具等。）2輸入（給出輸入數(shù)據(jù)或參數(shù)的要求。）（1）數(shù)據(jù)背景（說明數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。）（2）數(shù)據(jù)格式（如：（1）長度（2）格式基準（3）標號（4）順序（5）分隔符（6）詞匯表（7）省略和重復（8）控制。）（3）輸入舉例 3輸出（給出每項輸出數(shù)據(jù)的說明。）（1）數(shù)據(jù)背景（

17、說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。）（2）數(shù)據(jù)格式（詳細闡明每一輸出數(shù)據(jù)的格式,如:首部主體和尾部的具體形式。）（3）舉例3出錯和恢復（給出：（1）出錯信息及其含義（2）用戶應采取的措施，如修改、恢復、再啟動。）4求助查詢（說明如何操作。）五運行說明1 運行表 列出每種可能的運行情況,說明其運行目的.2 運行步驟 按順序說明每種運行的步驟,應包括:（1）運行控制（2）操作信息（1）運行目的（2）操作要求（3）啟動方法（4）預計運行時間（5）操作命令格式及說明（6）其他事項。）（3）輸入/輸出文件（給出建立和更新文件的有關信息，如：（1）文件的名稱及編號（2）記錄媒體（3）存留的目錄（4）文件的支配（說明確定保留文件或廢棄文件的準則，分發(fā)文件的對象，占用