在項(xiàng)目開發(fā)過程中，應(yīng)該按要求編寫好十三種文檔，文檔編制要求具有針對(duì)性、精確性、清晰性、完整性、靈活性、可追溯性。
◇
可行性分析報(bào)告：說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會(huì)因素上的可行性，評(píng)述為了合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實(shí)施方案，說明并論證所選定實(shí)施方案的理由。
◇ 項(xiàng)目開發(fā)計(jì)劃：為軟件項(xiàng)目實(shí)施方案制訂出具體計(jì)劃，應(yīng)該包括各部分工作的負(fù)責(zé)人員、開發(fā)的進(jìn)度、開發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等。
◇
軟件需求說明書（軟件規(guī)格說明書）：對(duì)所開發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說明。它是在用戶與開發(fā)人員雙方對(duì)軟件需求取得共同理解并達(dá)成協(xié)議的條件下編寫的，也是實(shí)施開發(fā)工作的基礎(chǔ)。該說明書應(yīng)給出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項(xiàng)要求，為生成和維護(hù)系統(tǒng)數(shù)據(jù)文件做好準(zhǔn)備。
◇
概要設(shè)計(jì)說明書：該說明書是概要實(shí)際階段的工作成果，它應(yīng)說明功能分配、模塊劃分、程序的總體結(jié)構(gòu)、輸入輸出以及接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為詳細(xì)設(shè)計(jì)提供基礎(chǔ)。
◇ 詳細(xì)設(shè)計(jì)說明書：著重描述每一模塊是怎樣實(shí)現(xiàn)的，包括實(shí)現(xiàn)算法、邏輯流程等。
◇
用戶操作手冊(cè)：本手冊(cè)詳細(xì)描述軟件的功能、性能和用戶界面，使用戶對(duì)如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運(yùn)行情況的有關(guān)知識(shí)，特別是操作方法的具體細(xì)節(jié)。
◇
測(cè)試計(jì)劃：為做好集成測(cè)試和驗(yàn)收測(cè)試，需為如何組織測(cè)試制訂實(shí)施計(jì)劃。計(jì)劃應(yīng)包括測(cè)試的內(nèi)容、進(jìn)度、條件、人員、測(cè)試用例的選取原則、測(cè)試結(jié)果允許的偏差范圍等。
◇ 測(cè)試分析報(bào)告：測(cè)試工作完成以后，應(yīng)提交測(cè)試計(jì)劃執(zhí)行情況的說明，對(duì)測(cè)試結(jié)果加以分析，并提出測(cè)試的結(jié)論意見。
◇
開發(fā)進(jìn)度月報(bào)：該月報(bào)系軟件人員按月向管理部門提交的項(xiàng)目進(jìn)展情況報(bào)告，報(bào)告應(yīng)包括進(jìn)度計(jì)劃與實(shí)際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個(gè)月的打算等。
◇
項(xiàng)目開發(fā)總結(jié)報(bào)告：軟件項(xiàng)目開發(fā)完成以后，應(yīng)與項(xiàng)目實(shí)施計(jì)劃對(duì)照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本和投入的人力，此外，還需對(duì)開發(fā)工作做出評(píng)價(jià)，總結(jié)出經(jīng)驗(yàn)和教訓(xùn)。
◇ 軟件維護(hù)手冊(cè)：主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護(hù)過程的說明，便于軟件的維護(hù)。
◇ 軟件問題報(bào)告：指出軟件問題的登記情況，如日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等，為軟件修改提供準(zhǔn)備文檔。
◇ 軟件修改報(bào)告：軟件產(chǎn)品投入運(yùn)行以后，發(fā)現(xiàn)了需對(duì)其進(jìn)行修正、更改等問題，應(yīng)將存在的問題、修改的考慮以及修改的影響作出詳細(xì)的描述，提交審批。
項(xiàng)目開發(fā)計(jì)劃
1 引言
1.1 編寫目的：闡明編寫可行性研究報(bào)告的目的，提出讀者對(duì)象
1.2 項(xiàng)目背景：應(yīng)包括
● 項(xiàng)目的委托單位、開發(fā)單位和主管部門；
● 該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。
1.3 定義：列出文檔中用到的專門術(shù)語的定義和縮寫詞的原文
1.4 參考資料：可包括：
● 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文
● 文檔所引用的資料、規(guī)范等
● 列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源；
2 項(xiàng)目概述
2.1 工作內(nèi)容:簡(jiǎn)要說明項(xiàng)目的各項(xiàng)主要工作，介紹所開發(fā)軟件的功能、性能等；若不編寫可行性研究報(bào)告；則應(yīng)在本節(jié)給出較詳細(xì)的介紹；
2.2 條件與限制:
闡明為完成項(xiàng)目應(yīng)具備的條件、開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件。必要時(shí)還應(yīng)說明用戶及分合同承擔(dān)的工作、完成期限及其他條件與限制。
2.3 產(chǎn)品
2.3.1程序：列出應(yīng)交付的程序名稱、使用的語言及存儲(chǔ)形式。
2.3.2文檔：列出應(yīng)交付的文檔。
2.4 運(yùn)行環(huán)境：應(yīng)包括硬件環(huán)境、軟件環(huán)境。
2.5 服務(wù)：闡明開發(fā)單位可向用戶提供的服務(wù)。如人員培訓(xùn)、安裝、保修、維護(hù)和其他運(yùn)行支持。
2.6 驗(yàn)收標(biāo)準(zhǔn)
3 實(shí)施計(jì)劃
3.1 任務(wù)分解：任務(wù)的劃分及各項(xiàng)任務(wù)的負(fù)責(zé)人。
3.2 進(jìn)度：按階段完成的項(xiàng)目，用圖表說明開始時(shí)間、完成時(shí)間。
3.3 預(yù)算
3.4 關(guān)鍵問題：說明可能影響項(xiàng)目的關(guān)鍵問題，如設(shè)備條件、技術(shù)難點(diǎn)或其他風(fēng)險(xiǎn)因素，并說明對(duì)策。
4 人員組織及分工
5 交付期限
6 專題計(jì)劃要點(diǎn)
如測(cè)試計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、人員培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等。
軟件需求說明書
1 引言
1.1 編寫目的：闡明編寫需求說明書的目的，指明讀者對(duì)象。
1.2 項(xiàng)目背景：應(yīng)包括
● 項(xiàng)目的委托單位、開心單位和主管部門；
● 該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。
1.3 定義：列出文檔中所用到的專門術(shù)語的定義和縮寫詞的愿文。
1.4 參考資料：可包括
● 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文
● 文檔所引用的資料、規(guī)范等
● 列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源
2 任務(wù)概述
2.1 目標(biāo)
2.2 運(yùn)行環(huán)境
2.3 條件與限制
3 數(shù)據(jù)描述
3.1 表態(tài)數(shù)據(jù)
3.2 動(dòng)態(tài)數(shù)據(jù)：包括輸入數(shù)據(jù)和輸出數(shù)據(jù)。
3.3 數(shù)據(jù)庫描述：給出使用數(shù)據(jù)庫的名稱和類型。
3.4 數(shù)據(jù)詞典
3.5 數(shù)據(jù)采集
4 功能需求
4.1功能劃分
4.2功能描述
5 性能需求
5.1 數(shù)據(jù)精確度
5.2 時(shí)間特性：如響應(yīng)時(shí)間、更新處理時(shí)間、數(shù)據(jù)轉(zhuǎn)換與傳輸時(shí)間、運(yùn)行時(shí)間等。
5.3 適應(yīng)性：在操作方式、運(yùn)行環(huán)境、與其他軟件的接口以及開發(fā)計(jì)劃等發(fā)生變化時(shí)，應(yīng)具有的適應(yīng)能力。
6 運(yùn)行需求
6.1 用戶界面：如屏幕格式、報(bào)表格式、菜單格式、輸入輸出時(shí)間等。
6.2 硬件接口
6.3 軟件接口
6.4 故障處理
7 其他需求
如可使用性、安全保密、可維護(hù)性、可移植性等。
概要設(shè)計(jì)說明書
1 引言
1.1 寫目的：闡明編寫概要設(shè)計(jì)說明書的目的，指明讀者對(duì)象。
1.2 項(xiàng)目背景：應(yīng)包括
● 項(xiàng)目的委托單位、開發(fā)單位和主管部門
● 該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。
1.3 定義：列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的愿意。
1.4 參考資料：
● 列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源
●項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說明書；測(cè)試計(jì)劃（初稿）；用戶操作手冊(cè)
● 文檔所引用的資料、采用的標(biāo)準(zhǔn)或規(guī)范。
2 任務(wù)概述
2.1 目標(biāo)
2.2 需求概述
2.3 條件與限制
3 總體設(shè)計(jì)
3.2 總體結(jié)構(gòu)和模塊外部設(shè)計(jì)
3.3 功能分配：表明各項(xiàng)功能與程序結(jié)構(gòu)的關(guān)系。
4 接口設(shè)計(jì)
4.1 外部接口：包括用戶界面、軟件接口與硬件接口。
4.2 內(nèi)部接口：模塊之間的接口。
5 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)
6 邏輯結(jié)構(gòu)設(shè)計(jì)
所有文檔的統(tǒng)一封面格式如下頁所示。
7 物理結(jié)構(gòu)設(shè)計(jì)
8 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系
9 運(yùn)行設(shè)計(jì)
9.1 運(yùn)行模塊的組合
9.2 運(yùn)行控制
9.3 運(yùn)行時(shí)間
10 出錯(cuò)處理設(shè)計(jì)
10.1 出錯(cuò)輸出信息
10.2 出錯(cuò)處理對(duì)策：如設(shè)置后備、性能降級(jí)、恢復(fù)及再啟動(dòng)等。
11 安全保密設(shè)計(jì)
12 維護(hù)設(shè)計(jì)
說明為方便維護(hù)工作的設(shè)施，如維護(hù)模塊等。
詳細(xì)設(shè)計(jì)說明書
1 引言
1.1 編寫目的：闡明編寫詳細(xì)設(shè)計(jì)說明書的目的，指明讀者對(duì)象。
1.2 項(xiàng)目背景：應(yīng)包括項(xiàng)目的來源和主管部門等。
1.3 定義：列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的愿意。
1.4 參考資料：
● 列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源
●項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說明書；概要設(shè)計(jì)說明書；測(cè)試計(jì)劃（初稿）；用戶操作手冊(cè)
● 文檔所引用的資料、軟件開發(fā)的標(biāo)準(zhǔn)或規(guī)范。
2 總體設(shè)計(jì)
2.1 需求概述
2.2 軟件結(jié)構(gòu)：如給出軟件系統(tǒng)的結(jié)構(gòu)圖。
3 程序描述
3.1 逐個(gè)模塊給出以下說明：
● 功能
● 性能
● 輸入項(xiàng)目
● 輸出項(xiàng)目
3.2 算法：模塊所選用的算法。
3.3 程序邏輯：詳細(xì)描述模塊實(shí)現(xiàn)的算法，可采用：標(biāo)準(zhǔn)流程圖；PDL語言；N-S圖；判定表等描述算法的圖表。
3.4 接口
● 存儲(chǔ)分配
● 限制條件
3.5測(cè)試要點(diǎn)：給出測(cè)試模塊的主要測(cè)試要求。
用戶操作手冊(cè)
1 引言
1.1 編寫目的：闡明編寫手冊(cè)的目的，指明讀者對(duì)象。
1.2 項(xiàng)目背景：說明項(xiàng)目的來源、委托單位、開發(fā)單位及和主管部門。
1.3 定義：列出手冊(cè)中使用的專門術(shù)語的定義和縮寫詞的愿意。
1.4 參考資料：
● 列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源
● 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說明書；概要設(shè)計(jì)說明書；詳細(xì)設(shè)計(jì)說明書；測(cè)試計(jì)劃
● 文檔中所引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。
2 軟件概述
2.1 目標(biāo)
2.2 功能
2.3 性能
2.4 數(shù)據(jù)精確度：包括輸入、輸出及處理數(shù)據(jù)的精度。
2.5 時(shí)間特性：如響應(yīng)時(shí)間、處理時(shí)間、數(shù)據(jù)傳輸時(shí)間等。
2.6 靈活性：在操作方式、運(yùn)行環(huán)境需做某些變更時(shí)軟件的適應(yīng)能力。
3 運(yùn)行環(huán)境
3.1 硬件
● 列出軟件系統(tǒng)運(yùn)行時(shí)所需的硬件最小配置，如計(jì)算機(jī)型號(hào)、主存容量
● 外存儲(chǔ)器、媒體、記錄格式、設(shè)備型號(hào)及數(shù)量
● 輸入、輸出設(shè)備
● 數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號(hào)及數(shù)量。
3.2 支持軟件
● 操作系統(tǒng)名稱及版本號(hào)
● 語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號(hào)
● 數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號(hào)
● 其他必要的支持軟件
4 使用說明
4.1 安裝和初始化：給出程序的存儲(chǔ)形式、操作命令、反饋信息及其做含意、表明安裝完成的測(cè)試實(shí)例以及安裝所需的軟件工具等。
4.2 輸入：給出輸入數(shù)據(jù)或參數(shù)的要求。
● 數(shù)據(jù)背景：說明數(shù)據(jù)來源、存儲(chǔ)媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。
● 數(shù)據(jù)格式:如長度、格式基準(zhǔn)、標(biāo)號(hào)、順序、分隔符、詞匯表、省略和重復(fù)、控制。
● 輸入舉例。
4.3 輸出：給出每項(xiàng)輸出數(shù)據(jù)的說明。
● 數(shù)據(jù)背景：說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。
● 數(shù)據(jù)格式：詳細(xì)闡明每一輸出數(shù)據(jù)的格式，如首部、主體和尾部的具體形式。
● 舉例
4.4 出錯(cuò)和恢復(fù)：給出出錯(cuò)信息及其含意；用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動(dòng)。
4.5 查詢：說明如何操作。
5 運(yùn)行說明
5.1 運(yùn)行表：列出每種可能的運(yùn)行情況，說明其運(yùn)行目的。
5.2 運(yùn)行步驟：按順序說明每和運(yùn)行的步驟，應(yīng)包括：
5.3 運(yùn)行控制
5.4 操作信息：運(yùn)行目的、運(yùn)行目的、操作要求、啟動(dòng)方法、預(yù)計(jì)運(yùn)行時(shí)間、操作命令格式及說明、其他事項(xiàng)；
5.5輸入/輸出文件：給出建立或更新文件的有關(guān)信息，如：文件的名稱及編號(hào)；記錄媒體；存留的目錄；文件的支配：說明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對(duì)象，戰(zhàn)勝硬件的優(yōu)先級(jí)及保密控制等。
5.6 啟動(dòng)或恢復(fù)過程
6 非常規(guī)過程
提供應(yīng)急戒非常規(guī)操作的必要信息及操作步驟，如出錯(cuò)處理操作、向后備系統(tǒng)切換操作及維護(hù)人員須知的操作和注意事項(xiàng)。
7 操作命令一覽表
按字母順序逐個(gè)列出全部操作命令的格式、功能及參數(shù)說明。
8 程序文件（或命令文件）和數(shù)據(jù)文件一覽表
按文件名字母順序或按功能與模塊分類順序逐個(gè)列出文件名稱、標(biāo)識(shí)符及說明。
9 用戶操作舉例
測(cè)試計(jì)劃
1 引言
1.1 編寫目的：闡明編寫測(cè)試計(jì)劃的目的并指明讀者對(duì)象。
1.2 項(xiàng)目背景：說明項(xiàng)目的來源、委托單位及主管部門。
1.3 定義：列出測(cè)試計(jì)劃中所用到的專門術(shù)語的定義和縮寫詞的原意。
1.4參考資料：列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源，可包括：項(xiàng)目的計(jì)劃任務(wù)書、合同或批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說明書；概要設(shè)計(jì)說明書；詳細(xì)設(shè)計(jì)說明書；用戶操作手冊(cè)；本測(cè)試計(jì)劃中引用的其他資料、采用
的軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。
2 任務(wù)概述
2.1 目標(biāo)
2.2 運(yùn)行環(huán)境
2.3 需求概述
2.4 條件與限制
3 計(jì)劃
3.1 測(cè)試方案：說明測(cè)試方法和選取測(cè)試用例的原則。
3.2 測(cè)試項(xiàng)目：列出組裝測(cè)試和確認(rèn)測(cè)試中每一項(xiàng)測(cè)試的內(nèi)容、名稱、目的和進(jìn)度。
3.3 測(cè)試準(zhǔn)備
3.4 測(cè)試機(jī)構(gòu)及人員：測(cè)試機(jī)構(gòu)名稱、負(fù)責(zé)人和職責(zé)。
4 測(cè)試項(xiàng)目說明
4.1 按順序逐個(gè)對(duì)測(cè)試項(xiàng)目做出說明
4.1.1 測(cè)試項(xiàng)目名稱及測(cè)試內(nèi)容
4.1.2 測(cè)試用例
4.1.3 輸入：輸入的數(shù)據(jù)和輸入命令。
4.1.4 輸出：預(yù)期的輸出數(shù)據(jù)。
4.2 步驟及操作
4.3 允許偏差：給出實(shí)測(cè)結(jié)果與預(yù)期結(jié)果之間允許偏差的范圍。
4.4 進(jìn)度
4.5 條件：給出項(xiàng)測(cè)試對(duì)資源的特殊要求，如設(shè)備、軟件、人員等。
4.6 測(cè)試資料：說明項(xiàng)測(cè)試所需的資料。
5 評(píng)價(jià)
5.1 范圍：說明所完成的各項(xiàng)測(cè)試說明問題的范圍及其局限性。
5.2 準(zhǔn)則：說明評(píng)論測(cè)試結(jié)果的準(zhǔn)則。
測(cè)試分析報(bào)告
1 引言
1.1 編寫目的：闡明編寫測(cè)試分析報(bào)告的目的并指明讀者對(duì)象。
1.2 項(xiàng)目背景：說明項(xiàng)目的來源、委托單位及主管部門。
1.3定義：列出測(cè)試分析報(bào)告中所用到的專門術(shù)語的定義和縮寫詞的原意。
1.4參考資料：列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源，可包括：項(xiàng)目的計(jì)劃任務(wù)書、合同或批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說明書；概要設(shè)計(jì)說明書；詳細(xì)設(shè)計(jì)說明書；用戶操作手冊(cè)；測(cè)試計(jì)劃；測(cè)試分析報(bào)告所引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或工程規(guī)范。
2 測(cè)試計(jì)劃招待情況
2.1 機(jī)構(gòu)和人員：給出測(cè)試機(jī)構(gòu)名稱、負(fù)責(zé)人和參與測(cè)試人員名單。
2.2 測(cè)試結(jié)果：按順序給出每一測(cè)試項(xiàng)目的：實(shí)測(cè)結(jié)果數(shù)據(jù)；與預(yù)期結(jié)果數(shù)據(jù)的偏差；該項(xiàng)測(cè)試表明的事實(shí)；該項(xiàng)測(cè)試發(fā)現(xiàn)的問題。
3 軟件需求測(cè)試結(jié)論
按順序給出每一項(xiàng)需求測(cè)試的結(jié)論。包括：證實(shí)的軟件能力；局限性（即項(xiàng)需求未得到充分測(cè)試的情況及原因。
4 評(píng)價(jià)
4.1 軟件能力：經(jīng)過測(cè)試所表明的軟件能力。
4.2 缺陷和限制：說明測(cè)試所揭露的軟件缺陷和不足，以及可能給軟件運(yùn)行帶來的影響。
4.3 建議：提出為彌補(bǔ)上述缺陷的建議。
4.4 測(cè)試結(jié)論：說明能否通過。
開發(fā)進(jìn)度月報(bào)
1 報(bào)告時(shí)間及所處的開發(fā)階段
2 工程進(jìn)度
2.1 本月內(nèi)的主要活動(dòng)
2.2 實(shí)際進(jìn)展與計(jì)劃比較
3 所用工時(shí)
按不同層次人員分別計(jì)時(shí)。