本文格式為Word版，下載可任意編輯——軟件開發(fā)文檔規(guī)范附附2:

軟件文檔編寫向?qū)臋n分類工程包括如下幾類文檔：

工程管理文檔。包括：《軟件工程籌劃》、《工程進度報告》、《工程開發(fā)總結(jié)報告》軟件開發(fā)文檔。包括：《需求規(guī)格說明》、《概要設(shè)計說明》、《細致設(shè)計說明》、《測試籌劃》、《軟件測試分析報告》。

產(chǎn)品文檔。包括：《用戶操作手冊》《演示文件》。

軟件工程籌劃

（SoftwareProjectPlan）

一．引言1．編寫目的（表明編寫軟件籌劃的目的，指出讀者對象。）

2．工程背景（可包括：（1）工程囑托單位、開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）

3．定義（列出本文檔中用到的特意術(shù)語的定義和縮略詞的原文。）

4．參考資料（可包括：文檔所引用的資料、模范等；列出資料的、標題、編號、發(fā)表日期、出版單位或資料來源。）

二．工程概述1.工作內(nèi)容（簡要說明工程的各項主要工作,介紹所開發(fā)軟件的功能性能等.若不編寫可行性研究報告,那么應(yīng)在本節(jié)給出較細致的介紹。)2.條件與限制（表明為完成工程應(yīng)具備的條件開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件.必要時還應(yīng)說明用戶及分合同承包者承受的工作完成期限及其它條件與限制。）

3.產(chǎn)品（1）程序（列出應(yīng)交付的程序名稱使用的語言及存儲形式。）

（2）文檔（列出應(yīng)交付的文檔。）

（3）運行環(huán)境（應(yīng)包括硬件環(huán)境軟件環(huán)境。）

4．服務(wù)（表明開發(fā)單位可向用戶供給的服務(wù).如人員培訓(xùn)安裝保修維護和其他運行支持。）

5．驗收標準三．實施籌劃1．任務(wù)分解（任務(wù)的劃分及各項任務(wù)的負責人。）

2．進度（按階段完成的工程,用圖表說明開頭時間完成時間。）

3．預(yù)算4．關(guān)鍵問題（說明可能影響工程的關(guān)鍵問題,如設(shè)備條件技術(shù)難點或其他風(fēng)險因素,并說明對策。）

四．人員組織及分工五．交付期限六．專題籌劃要點（如測試籌劃等。）

工程開發(fā)進度報告

一．報告時間及所處的開發(fā)階段二．給出進度1．本周的主要活動2．實際進展與籌劃對比三．所用工時（按不同層次人員分別計時。）

四．全體機時五．工作遇到的問題及采取的對策六．本周完成的成果七．下周的工作籌劃八．特殊問題工程開發(fā)總結(jié)報告

一．引言1．編寫目的（表明編寫總結(jié)報告的目的,指明讀者對象。）

2．工程背景（說明工程的來源、囑托單位、開發(fā)單位及主管部門。）

3．定義（列出報告中用到的特意術(shù)語定義和縮寫詞的原意。）

4．參考資料（列出這些資料的、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）工程開發(fā)籌劃；（2）需求規(guī)格說明書；（3）概要設(shè)計說明書；（4）細致設(shè)計說明書；（5）用戶操作手冊；（6）測試籌劃；（7）測試分析報告（8）本報告引用的其他資料、采用的開發(fā)標準或開發(fā)模范。）

二．開發(fā)結(jié)果1．產(chǎn)品（可包括：（1）列出各片面的程序名稱、源程序行數(shù)（包括解釋行）或目標程序字節(jié)數(shù)及程序總計數(shù)量、存儲形式；產(chǎn)品文檔名稱等。）

2．主要功能及性能3．所用工時（按人員的不同層次分別計時。）

4．所用機時5．進度（給出籌劃進度與實際進度的比較。）

三．評價1．生產(chǎn)率評價（如平均每人每周源程序行數(shù)、文檔的字數(shù)等。）

2．技術(shù)方案評價3．產(chǎn)品質(zhì)量評價四．閱歷與教訓(xùn)

需求規(guī)格說明書

（RequirementsSpecification）

一．引言1．編寫目的（表明編寫需求說明書的目的,指明讀者對象。）

2．工程背景（可包括：（1）工程的囑托單位,開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）

3．定義（列出文檔中用到的特意術(shù)語定義和縮寫詞的原文。）

4．參考資料（可包括：（1）工程開發(fā)籌劃；（2）文檔所引用的資料，標準和模范。列出這些資料的、標題、編號、發(fā)表日期、出版單位或資料來源。）

二．任務(wù)概述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．時間特性（如響應(yīng)時間、更新處理時間、數(shù)據(jù)轉(zhuǎn)化與傳輸時間、運行時間等。）

3．適應(yīng)性（在操作方式運行環(huán)境與其他軟件的接口以及開發(fā)籌劃等發(fā)生變化時，應(yīng)具有的適應(yīng)才能。）

六．運行需求1．用戶界面（如屏幕格式、報表格式、菜單格式、輸入輸出時間等。）

2．硬件接口3．軟件接口4．故障處理七．其他需求（如可使用性、安好保密、可維護性、可移植性等。）

概要設(shè)計說明書

（ArchitecturalDesignSpecification）

一．引言1．編寫目的（表明編寫概要設(shè)計說明書的目的，指明讀者對象。）

2．工程背景（可包括：（1）工程的囑托單位,開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）

3．定義（列出文檔中用到的特意術(shù)語定義和縮寫詞的原意。）

4．參考資料（列出這些資料的、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）工程開發(fā)籌劃；（2）需求規(guī)格說明書；（3）測試籌劃（初稿）；（4）用戶操作手冊（初稿）；（5）文檔所引用的資料、采用的標準或模范。）

二．任務(wù)概述1．目標2．運行環(huán)境3．需求概述4．條件與限制三．總體設(shè)計1．處理流程2．總體布局和模塊外部設(shè)計3．功能調(diào)配（說明各項功能與程序布局的關(guān)系。）

四．接口設(shè)計1．外部接口（包括用戶界面軟件接口與硬件接口。）

2．內(nèi)部接口（模塊之間的接口。）

五．數(shù)據(jù)布局設(shè)計1．規(guī)律布局設(shè)計

2．物理布局設(shè)計3．數(shù)據(jù)布局與程序的關(guān)系六．運行設(shè)計1．運行模塊的組合2．運行操縱3．運行時間七．出錯處理設(shè)計1．出錯輸出信息2．出錯處理對策（如設(shè)置后備、性能降級、恢復(fù)及再啟動等。）

八．安好保密設(shè)計九．維護設(shè)計（說明為便當維護工作的設(shè)施,如維護模塊等。）

細致設(shè)計說明書

（ProceduralDesignSpecification）

一．引言1．編寫目的（表明編寫細致設(shè)計說明書的目的,指明讀者對象。）

2．工程背景（應(yīng)包括工程的來源和主管部門等。）

3．定義（列出文檔中用到的特意術(shù)語定義和縮寫詞的原意。）

4．參考資料（列出這些資料的、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）工程開發(fā)籌劃；（2）需求規(guī)格說明書；（3）概要設(shè)計說明書；（4）測試籌劃(初稿)；（5）用戶操作手冊(初稿)；（5）文檔所引用的其他資料、軟件開發(fā)標準或模范。）

二．總體設(shè)計1．需求概述2．軟件布局（如給出軟件系統(tǒng)的結(jié)果圖。）

三．程序描述（逐個模塊給出以下的說明:：）

1．功能2．性能3．輸入工程4．輸出工程5．算法（模塊所選用的算法。）

6．程序規(guī)律（細致描述模塊實現(xiàn)的算法，可采用:：（1）標準流程圖；（2）N-S圖；（3）PAD；（4）判定表等描述算法的圖表。）

7．接口

8．存儲調(diào)配9．限制條件10．測試要點（給出測試模塊的主要測試要求。）

測試籌劃（TestPlan）

一、引言1．編寫目的（表明編寫測試籌劃的目的,指明讀者對象。）

2．工程背景（說明工程的來源囑托單位及主管部門。）

3．定義（列出測試籌劃中用到的特意術(shù)語定義和縮寫詞的原意。）

4．參考資料（列出這些資料的、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）工程開發(fā)籌劃；（2）需求規(guī)格說明書；（3）概要設(shè)計說明書；（4）細致設(shè)計說明書；（5）用戶操作手冊;(6)本測試籌劃中引用的其他資料采用的軟件開發(fā)標準或模范。）

二．任務(wù)概述1．目標2．運行環(huán)境3．需求概述4．條件與限制三．籌劃1．測試方案（說明確定測試方法和選取測試用例的原那么。）

2．測試工程（列出組裝測試和確認測試中每一項測試的內(nèi)容、名稱、目的和進度。）

3．測試打定4．測試機構(gòu)及人員（測試機構(gòu)名稱負責人和職責。）

四．測試工程說明（按依次逐個對測試工程做出說明：）

1．測試工程名稱及測試內(nèi)容2．測試用例（1）輸入（輸入的數(shù)據(jù)和輸入的命令。）

（2）輸出（預(yù)期的輸出數(shù)據(jù)。）

（3）步驟及操作（4）允許偏差（給出實測結(jié)果與預(yù)料結(jié)果之間允許偏差的范圍。）

3．進度4．條件（給出項測試對資源的特殊要求，如設(shè)備、軟件、人員等。）

5．測試資料（說明項測試所需的資料。）

五．評價1．范圍（說明所完成的各項測試說明問題的范圍及其局限性。）

2．準那么（說明評價測試結(jié)果的準那么。）

測試分析報告（TestSpecification）

一．引言1．編寫目的（表明編寫測試分析報告的目的，指明讀者對象。）

2．工程背景（說明工程的來源、囑托單位及主管部門。）

3．定義（列出測試分析報告中用到的特意術(shù)語定義和縮寫詞的原意。）

4．參考資料（列出這些資料的、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）工程開發(fā)籌劃；（2）需求規(guī)格說明書；（3）概要設(shè)計說明書；（4）細致設(shè)計說明書；（5）用戶操作手冊；（6）測試籌劃；（7）測試分析報告所引用的其他資料、采用的軟件工程標準或軟件工程模范。）

二．測試籌劃執(zhí)行處境1．測試工程（列出每一測試工程的名稱、內(nèi)容和目的。）

2．測試機構(gòu)和人員（給出測試機構(gòu)名稱、負責人和參與測試人員名單。）

3．測試結(jié)果（按依次給出每一測試工程的：（1）實測結(jié)果數(shù)據(jù)（2）與預(yù)期結(jié)果數(shù)據(jù)的偏差（3）該項測試說明的事實（4）該項測試察覺的問題。）

三．軟件需求測試結(jié)論按依次給出每一項需求測試的結(jié)論。包括：（1）表明的軟件才能（2）局限性（即項需求未得到充分測試的處境及理由）。

四．評價1．軟件才能（經(jīng)過測試所說明的軟件才能。）

2．缺陷和限制（說明測試所揭露的軟件缺陷和缺乏,以及可能給軟件運行帶來的影響。）

3．建議（提出為彌補上述缺陷的建議。）

4．測試結(jié)論（說明能否通過。）

用戶操作手冊（UserGuide）

一．引言1．編寫目的（表明編寫手冊的目的，指明讀者對象。）

2．工程背景（說明工程的來源、囑托單位、開發(fā)單位及主管部門。）

3．定義（列出手冊中用到的特意術(shù)語定義和縮寫詞的原意。）

4．參考資料（列出這些資料的、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）工程開發(fā)籌劃；（2）需求規(guī)格說明書；（3）概要設(shè)計說明書；（4）細致設(shè)計說明書；（5）測試籌劃；（6）手冊中引用的其他資料、采用的軟件工程標準或軟件工程模范。）

二．軟件概述

1．目標2．功能3．性能（1）數(shù)據(jù)精確度（包括輸入、輸出及處理數(shù)據(jù)的精度。）

（2）時間特性（如響應(yīng)時間、處理時間、數(shù)據(jù)傳輸時間等。）

（3）生動性（在操作方式、運行環(huán)境需做某些變更時軟件的適應(yīng)才能。）

三．運行環(huán)境1．硬件（列出軟件系統(tǒng)運行時所需的硬件最小配置，如：（1）計算機型號、主存容量；（2）外存儲器、媒體、記錄格式、設(shè)備型號及數(shù)量；（3）輸入、輸出設(shè)備；（4）數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號及數(shù)量。）

2．支持軟件（如：（1）操作系統(tǒng)名稱及版本號；（2）語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號；（3）數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號；（4）其他必要的支持軟件。）

四．使用說明1．安裝和初始化（給出程序的存儲形式、操作命令、反應(yīng)信息及其含義、說明安裝完成的測試實例以及安裝所需的軟件工具等。）

2．輸入（給出輸入數(shù)據(jù)或參數(shù)的要求。）

（1）數(shù)據(jù)背景（說明數(shù)據(jù)來源、存儲媒體、展現(xiàn)頻度、限制和質(zhì)量管理等。）

（2）數(shù)據(jù)格式（如：（1）長度（2）格式基準（3）標號（4）依次（5）分隔符（6）詞匯表（7）省略和重復(fù)（8）操縱。）

（3）輸入舉例3．輸出（給出每項輸出數(shù)據(jù)的說明。）

（1）數(shù)據(jù)背景（說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。）

（2）數(shù)據(jù)格式（細致表明每一輸出數(shù)據(jù)的格式,如:首部主體和尾部的概括形式。）

（3）舉例3．出錯和恢復(fù)（給出：（1）出錯信息及其含義（2）用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動。）

4．求助查詢（說明如何操作。）

五．運行說明1．運行表[列出每種可能的運行處境,說明其運行目的.]2．運行步驟[按依次說明每種運行的步驟,應(yīng)包括:]（1）運行操縱（2）操作信息（（1）運行目的（2）操作要求（3）啟動方法（4）預(yù)計運行時間（5）操作命令格式及說明（6）其他事項。）

（3）輸入/輸出文件（給出建立和更