在項(xiàng)目開(kāi)發(fā)過(guò)程中，應(yīng)該按要求編寫(xiě)好十三種文檔，文檔編制要求具有針對(duì)性、精確性、清晰性、完整性、靈活性、可追溯性。

　　◇ 可行性分析報(bào)告：說(shuō)明該軟件開(kāi)發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會(huì)因素上的可行性，評(píng)述為了合理地達(dá)到開(kāi)發(fā)目標(biāo)可供選擇的各種可能實(shí)施方案，說(shuō)明并論證所選定實(shí)施方案的理由。?
◇ 項(xiàng)目開(kāi)發(fā)計(jì)劃：為軟件項(xiàng)目實(shí)施方案制訂出具體計(jì)劃，應(yīng)該包括各部分工作的負(fù)責(zé)人員、開(kāi)發(fā)的進(jìn)度、開(kāi)發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等。?
◇ 軟件需求說(shuō)明書(shū)（軟件規(guī)格說(shuō)明書(shū)）：對(duì)所開(kāi)發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說(shuō)明。它是在用戶與開(kāi)發(fā)人員雙方對(duì)軟件需求取得共同理解并 達(dá)成協(xié)議的條件下編寫(xiě)的，也是實(shí)施開(kāi)發(fā)工作的基礎(chǔ)。該說(shuō)明書(shū)應(yīng)給出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項(xiàng)要求，為生成和維護(hù)系統(tǒng)數(shù)據(jù)文件做好準(zhǔn)備。?
◇ 概要設(shè)計(jì)說(shuō)明書(shū)：該說(shuō)明書(shū)是概要實(shí)際階段的工作成果，它應(yīng)說(shuō)明功能分配、模塊劃分、程序的總體結(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ì)說(shuō)明書(shū)：著重描述每一模塊是怎樣實(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í)行情況的說(shuō)明，對(duì)測(cè)試結(jié)果加以分析，并提出測(cè)試的結(jié)論意見(jiàn)。?
◇ 開(kāi)發(fā)進(jìn)度月報(bào)：該月報(bào)系軟件人員按月向管理部門提交的項(xiàng)目進(jìn)展情況報(bào)告，報(bào)告應(yīng)包括進(jìn)度計(jì)劃與實(shí)際執(zhí)行情況的比較、階段成果、遇到的問(wèn)題和解決的辦法以及下個(gè)月的打算等。?
◇ 項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告：軟件項(xiàng)目開(kāi)發(fā)完成以后，應(yīng)與項(xiàng)目實(shí)施計(jì)劃對(duì)照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本和投入的人力，此外，還需對(duì)開(kāi)發(fā)工作做出評(píng)價(jià)，總結(jié)出經(jīng)驗(yàn)和教訓(xùn)。?
◇ 軟件維護(hù)手冊(cè)：主要包括軟件系統(tǒng)說(shuō)明、程序模塊說(shuō)明、操作環(huán)境、支持軟件的說(shuō)明、維護(hù)過(guò)程的說(shuō)明，便于軟件的維護(hù)。?
◇ 軟件問(wèn)題報(bào)告：指出軟件問(wèn)題的登記情況，如日期、發(fā)現(xiàn)人、狀態(tài)、問(wèn)題所屬模塊等，為軟件修改提供準(zhǔn)備文檔。?
◇ 軟件修改報(bào)告：軟件產(chǎn)品投入運(yùn)行以后，發(fā)現(xiàn)了需對(duì)其進(jìn)行修正、更改等問(wèn)題，應(yīng)將存在的問(wèn)題、修改的考慮以及修改的影響作出詳細(xì)的描述，提交審批。

可行性分析報(bào)告

1 引言?
1.1 編寫(xiě)目的：闡明編寫(xiě)可行性研究報(bào)告的目的，提出讀者對(duì)象。?
1.2 項(xiàng)目背景：應(yīng)包括?
● 所建議開(kāi)發(fā)軟件的名稱?
● 項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶及實(shí)現(xiàn)軟件的單位?
● 項(xiàng)目與其他軟件或其他系統(tǒng)的關(guān)系。?
1.3 定義：列出文檔中用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的原文。?
1.4 參考資料：列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可包括?
● 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)、合同或上級(jí)機(jī)關(guān)的批文?
● 與項(xiàng)目有關(guān)的已發(fā)表的資料?
● 文檔中所引用的資料，所采用的軟件標(biāo)準(zhǔn)或規(guī)范?
2 可行性研究的前提?
2.1 要求：列出并說(shuō)明建議開(kāi)發(fā)軟件的的基本要求，如?
● 功能?
● 性能?
● 輸入/輸出?
● 基本的數(shù)據(jù)流程和處理流程?
● 安全與保密要求?
● 與軟件相關(guān)的其他系統(tǒng)?
● 完成日期?
2.2 目標(biāo)：可包括?
● 人力與設(shè)備費(fèi)用的節(jié)省?
● 處理速度的提高?
● 控制精度或生產(chǎn)力的提高?
● 管理信息服務(wù)的改進(jìn)?
● 決策系統(tǒng)的改進(jìn)?
● 人員工作效率的提高?
2.3 條件、假定和限制：可包括?
● 建議開(kāi)發(fā)軟件運(yùn)行的最短壽命?
● 進(jìn)行顯然方案選擇比較的期限?
● 經(jīng)費(fèi)來(lái)源和使用限制?
● 法律和政策方面的限制?
● 硬件、軟件、運(yùn)行環(huán)境和開(kāi)發(fā)環(huán)境的條件和限制?
● 可利用的信息和資源?
● 建議開(kāi)發(fā)軟件投入使用的最遲時(shí)間?
2.4 可行性研究方法?
2.5 決定可行性的主要因素?
3 對(duì)現(xiàn)有系統(tǒng)的分析?
3.1 處理流程和數(shù)據(jù)流程?
3.2 工作負(fù)荷?
3.3 費(fèi)用支出：如人力、設(shè)備、空間、支持性服務(wù)、材料等項(xiàng)開(kāi)支?
3.4 人員：列出所需人員的專業(yè)技術(shù)類別和數(shù)量?
3.5 設(shè)備?
3.6 局限性：說(shuō)明現(xiàn)有系統(tǒng)存在的問(wèn)題以及為什么需要開(kāi)發(fā)新的系統(tǒng)?
4 所建議技術(shù)可行性分析?
4.1 對(duì)系統(tǒng)的簡(jiǎn)要描述?
4.2 與現(xiàn)有系統(tǒng)比較的優(yōu)越性?
4.3 處理流程和數(shù)據(jù)流程?
4.4 采用建議系統(tǒng)可能帶來(lái)的影響?
● 對(duì)設(shè)備的影響?
● 對(duì)現(xiàn)有軟件的影響?
● 對(duì)用戶的影響?
● 對(duì)系統(tǒng)運(yùn)行的影響?
● 對(duì)開(kāi)發(fā)環(huán)境的影響?
● 對(duì)經(jīng)費(fèi)支出的影響?
4.5 技術(shù)可行性評(píng)價(jià):包括?
● 在限制條件下，功能目的是否達(dá)到?
● 利用現(xiàn)有技術(shù)，功能目的是否達(dá)到?
● 對(duì)開(kāi)發(fā)人員數(shù)量和質(zhì)量的要求，并說(shuō)明能否滿足?
● 在規(guī)定的期限內(nèi)，開(kāi)發(fā)能否完成?
5 所建議系統(tǒng)經(jīng)濟(jì)可行性分析?
5.1 支出?
5.2 效益?
5.3 收益/投資比?
5.4 投資回收周期?
5.5 敏感性分析：指一些關(guān)鍵性因素，如：?
● 系統(tǒng)生存周期長(zhǎng)短?
● 系統(tǒng)工作負(fù)荷量?
● 處理速度要求?
● 設(shè)備和軟件配置變化對(duì)支出和效益的影響等的分析?
6 社會(huì)因素可行性分析?
6.1 法律因素：如?
● 合同責(zé)任?
● 侵犯專利權(quán)?
● 侵犯版權(quán)?
6.2 用戶使用可行性：如?
● 用戶單位的行政管理?
● 工作制度?
● 人員素質(zhì)等能否滿足要求?
7 其他可供選擇的方案?
逐個(gè)闡明其它可供選擇的方案，并重點(diǎn)說(shuō)明未被推薦的理由。?
8 結(jié)論意見(jiàn)?
● 可著手組織開(kāi)發(fā)?
● 需等待若干條件具備后才能開(kāi)發(fā)?
● 需對(duì)開(kāi)發(fā)目標(biāo)進(jìn)行某些修改?
● 不能進(jìn)行或不必進(jìn)行?
● 其它

項(xiàng)目開(kāi)發(fā)計(jì)劃

1 引言?
1.1 編寫(xiě)目的：闡明編寫(xiě)可行性研究報(bào)告的目的，提出讀者對(duì)象?
1.2 項(xiàng)目背景：應(yīng)包括?
● 項(xiàng)目的委托單位、開(kāi)發(fā)單位和主管部門；?
● 該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。?
1.3 定義：列出文檔中用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的原文?
1.4 參考資料：可包括：?
● 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)、合同或上級(jí)機(jī)關(guān)的批文?
● 文檔所引用的資料、規(guī)范等?
● 列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源；?
2 項(xiàng)目概述?
2.1 工作內(nèi)容:簡(jiǎn)要說(shuō)明項(xiàng)目的各項(xiàng)主要工作，介紹所開(kāi)發(fā)軟件的功能、性能等；若不編寫(xiě)可行性研究報(bào)告；則應(yīng)在本節(jié)給出較詳細(xì)的介紹；?
2.2 條件與限制: 闡明為完成項(xiàng)目應(yīng)具備的條件、開(kāi)發(fā)單位已具備的條件以及尚需創(chuàng)造的條件。必要時(shí)還應(yīng)說(shuō)明用戶及分合同承擔(dān)的工作、完成期限及其他條件與限制。?
2.3 產(chǎn)品?
2.3.1程序：列出應(yīng)交付的程序名稱、使用的語(yǔ)言及存儲(chǔ)形式。?
2.3.2文檔：列出應(yīng)交付的文檔。?
2.4 運(yùn)行環(huán)境：應(yīng)包括硬件環(huán)境、軟件環(huán)境。?
2.5 服務(wù)：闡明開(kāi)發(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)目，用圖表說(shuō)明開(kāi)始時(shí)間、完成時(shí)間。?
3.3 預(yù)算?
3.4 關(guān)鍵問(wèn)題：說(shuō)明可能影響項(xiàng)目的關(guān)鍵問(wèn)題，如設(shè)備條件、技術(shù)難點(diǎn)或其他風(fēng)險(xiǎn)因素，并說(shuō)明對(duì)策。?
4 人員組織及分工?
5 交付期限?
6 專題計(jì)劃要點(diǎn)?
如測(cè)試計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、人員培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等。

軟件需求說(shuō)明書(shū)

1 引言?
1.1 編寫(xiě)目的：闡明編寫(xiě)需求說(shuō)明書(shū)的目的，指明讀者對(duì)象。?
1.2 項(xiàng)目背景：應(yīng)包括?
● 項(xiàng)目的委托單位、開(kāi)心單位和主管部門；?
● 該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。?
1.3 定義：列出文檔中所用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的愿文。?
1.4 參考資料：可包括?
● 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)、合同或上級(jí)機(jī)關(guān)的批文?
● 文檔所引用的資料、規(guī)范等?
● 列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源?
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ù)庫(kù)描述：給出使用數(shù)據(jù)庫(kù)的名稱和類型。?
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)境、與其他軟件的接口以及開(kāi)發(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ì)說(shuō)明書(shū)

1 引言?
1.1 寫(xiě)目的：闡明編寫(xiě)概要設(shè)計(jì)說(shuō)明書(shū)的目的，指明讀者對(duì)象。?
1.2 項(xiàng)目背景：應(yīng)包括?
● 項(xiàng)目的委托單位、開(kāi)發(fā)單位和主管部門?
● 該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。?
1.3 定義：列出本文檔中所用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的愿意。?
1.4 參考資料：?
● 列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源?
●項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)、合同或上級(jí)機(jī)關(guān)的批文；項(xiàng)目開(kāi)發(fā)計(jì)劃；需求規(guī)格說(shuō)明書(shū)；測(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)一封面格式如下頁(yè)所示。?
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ì)?
說(shuō)明為方便維護(hù)工作的設(shè)施，如維護(hù)模塊等。

詳細(xì)設(shè)計(jì)說(shuō)明書(shū)

1 引言?
1.1 編寫(xiě)目的：闡明編寫(xiě)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)的目的，指明讀者對(duì)象。?
1.2 項(xiàng)目背景：應(yīng)包括項(xiàng)目的來(lái)源和主管部門等。?
1.3 定義：列出本文檔中所用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的愿意。?
1.4 參考資料：?
● 列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源?
●項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)、合同或上級(jí)機(jī)關(guān)的批文；項(xiàng)目開(kāi)發(fā)計(jì)劃；需求規(guī)格說(shuō)明書(shū)；概要設(shè)計(jì)說(shuō)明書(shū)；測(cè)試計(jì)劃（初稿）；用戶操作手冊(cè)?
● 文檔所引用的資料、軟件開(kāi)發(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è)模塊給出以下說(shuō)明：?
● 功能?
● 性能?
● 輸入項(xiàng)目?
● 輸出項(xiàng)目?
3.2 算法：模塊所選用的算法。?
3.3 程序邏輯：詳細(xì)描述模塊實(shí)現(xiàn)的算法，可采用：標(biāo)準(zhǔn)流程圖；PDL語(yǔ)言；N-S圖；判定表等描述算法的圖表。?
3.4 接口?
● 存儲(chǔ)分配?
● 限制條件?
3.5測(cè)試要點(diǎn)：給出測(cè)試模塊的主要測(cè)試要求。

用戶操作手冊(cè)

1 引言?
1.1 編寫(xiě)目的：闡明編寫(xiě)手冊(cè)的目的，指明讀者對(duì)象。?
1.2 項(xiàng)目背景：說(shuō)明項(xiàng)目的來(lái)源、委托單位、開(kāi)發(fā)單位及和主管部門。?
1.3 定義：列出手冊(cè)中使用的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的愿意。?
1.4 參考資料：?
● 列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源?
● 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)、合同或上級(jí)機(jī)關(guān)的批文；項(xiàng)目開(kāi)發(fā)計(jì)劃；需求規(guī)格說(shuō)明書(shū)；概要設(shè)計(jì)說(shuō)明書(shū)；詳細(xì)設(shè)計(jì)說(shuō)明書(shū)；測(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)?
● 語(yǔ)言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號(hào)?
● 數(shù)據(jù)庫(kù)管理系統(tǒng)的名稱及版本號(hào)?
● 其他必要的支持軟件?
4 使用說(shuō)明?
4.1 安裝和初始化：給出程序的存儲(chǔ)形式、操作命令、反饋信息及其做含意、表明安裝完成的測(cè)試實(shí)例以及安裝所需的軟件工具等。?
4.2 輸入：給出輸入數(shù)據(jù)或參數(shù)的要求。?
● 數(shù)據(jù)背景：說(shuō)明數(shù)據(jù)來(lái)源、存儲(chǔ)媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。?
● 數(shù)據(jù)格式:如長(zhǎng)度、格式基準(zhǔn)、標(biāo)號(hào)、順序、分隔符、詞匯表、省略和重復(fù)、控制。?
● 輸入舉例。?
4.3 輸出：給出每項(xiàng)輸出數(shù)據(jù)的說(shuō)明。?
● 數(shù)據(jù)背景：說(shuō)明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。?
● 數(shù)據(jù)格式：詳細(xì)闡明每一輸出數(shù)據(jù)的格式，如首部、主體和尾部的具體形式。?
● 舉例?
4.4 出錯(cuò)和恢復(fù)：給出出錯(cuò)信息及其含意；用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動(dòng)。?
4.5 求助查詢：說(shuō)明如何操作。?
5 運(yùn)行說(shuō)明?
5.1 運(yùn)行表：列出每種可能的運(yùn)行情況，說(shuō)明其運(yùn)行目的。?
5.2 運(yùn)行步驟：按順序說(shuō)明每和運(yùn)行的步驟，應(yīng)包括：?
5.3 運(yùn)行控制?
5.4 操作信息：運(yùn)行目的、運(yùn)行目的、操作要求、啟動(dòng)方法、預(yù)計(jì)運(yùn)行時(shí)間、操作命令格式及說(shuō)明、其他事項(xiàng)；?
5.5輸入/輸出文件：給出建立或更新文件的有關(guān)信息，如：文件的名稱及編號(hào)；記錄媒體；存留的目錄；文件的支配：說(shuō)明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對(duì)象，戰(zhàn)勝硬件的優(yōu)先級(jí)及保密控制等。?
5.6 啟動(dòng)或恢復(fù)過(guò)程?
6 非常規(guī)過(guò)程?
提供應(yīng)急戒非常規(guī)操作的必要信息及操作步驟，如出錯(cuò)處理操作、向后備系統(tǒng)切換操作及維護(hù)人員須知的操作和注意事項(xiàng)。?
7 操作命令一覽表?
按字母順序逐個(gè)列出全部操作命令的格式、功能及參數(shù)說(shuō)明。?
8 程序文件（或命令文件）和數(shù)據(jù)文件一覽表?
按文件名字母順序或按功能與模塊分類順序逐個(gè)列出文件名稱、標(biāo)識(shí)符及說(shuō)明。?
9 用戶操作舉例

測(cè)試計(jì)劃

1 引言?
1.1 編寫(xiě)目的：闡明編寫(xiě)測(cè)試計(jì)劃的目的并指明讀者對(duì)象。?
1.2 項(xiàng)目背景：說(shuō)明項(xiàng)目的來(lái)源、委托單位及主管部門。?
1.3 定義：列出測(cè)試 計(jì)劃中所用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的原意。?
1.4參考資料：列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可包括：項(xiàng)目的計(jì)劃任務(wù)書(shū)、合同或批文；項(xiàng)目開(kāi)發(fā)計(jì)劃；需求規(guī)格說(shuō)明書(shū)；概要設(shè)計(jì)說(shuō)明書(shū)；詳細(xì)設(shè)計(jì)說(shuō)明書(shū)；用戶操作手冊(cè)；本測(cè)試計(jì)劃中引用的其他資料、采用?
的軟件開(kāi)發(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è)試方案：說(shuō)明測(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)目說(shuō)明?
4.1 按順序逐個(gè)對(duì)測(cè)試項(xiàng)目做出說(shuō)明?
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è)試資料：說(shuō)明項(xiàng)測(cè)試所需的資料。?
5 評(píng)價(jià)?
5.1 范圍：說(shuō)明所完成的各項(xiàng)測(cè)試說(shuō)明問(wèn)題的范圍及其局限性。?
5.2 準(zhǔn)則：說(shuō)明評(píng)論測(cè)試結(jié)果的準(zhǔn)則。

測(cè)試分析報(bào)告

1 引言?
1.1 編寫(xiě)目的：闡明編寫(xiě)測(cè)試分析報(bào)告的目的并指明讀者對(duì)象。?
1.2 項(xiàng)目背景：說(shuō)明項(xiàng)目的來(lái)源、委托單位及主管部門。?
1.3定義：列出測(cè)試分析報(bào)告中所用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的原意。?
1.4參考資料：列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可包括：項(xiàng)目的計(jì)劃任務(wù)書(shū)、合同或批文；項(xiàng)目開(kāi)發(fā)計(jì)劃；需求規(guī)格說(shuō)明 書(shū)；概要設(shè)計(jì)說(shuō)明書(shū)；詳細(xì)設(shè)計(jì)說(shuō)明書(shū)；用戶操作手冊(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)的問(wèn)題。?
3 軟件需求測(cè)試結(jié)論?
按順序給出每一項(xiàng)需求測(cè)試的結(jié)論。包括：證實(shí)的軟件能力；局限性（即項(xiàng)需求未得到充分測(cè)試的情況及原因。?
4 評(píng)價(jià)?
4.1 軟件能力：經(jīng)過(guò)測(cè)試所表明的軟件能力。?
4.2 缺陷和限制：說(shuō)明測(cè)試所揭露的軟件缺陷和不足，以及可能給軟件運(yùn)行帶來(lái)的影響。?
4.3 建議：提出為彌補(bǔ)上述缺陷的建議。?
4.4 測(cè)試結(jié)論：說(shuō)明能否通過(guò)。

開(kāi)發(fā)進(jìn)度月報(bào)

1 報(bào)告時(shí)間及所處的開(kāi)發(fā)階段?
2 工程進(jìn)度?
2.1 本月內(nèi)的主要活動(dòng)?
2.2 實(shí)際進(jìn)展與計(jì)劃比較?
3 所用工時(shí)?
按不同層次人員分別計(jì)時(shí)。?
4 所用機(jī)時(shí)?
按所用計(jì)算機(jī)機(jī)型分別計(jì)時(shí)。?
5 經(jīng)費(fèi)支出?
分類列出本月經(jīng)費(fèi)支出項(xiàng)目，給出支出總額，并與計(jì)劃比較。?
6 工作遇到的問(wèn)題及采取的對(duì)策?
7 本月完成的成果?
8 下月的工作計(jì)劃?
9 特殊問(wèn)題

項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告

1 引言?
1.1 編寫(xiě)目的：闡明編寫(xiě)總結(jié)報(bào)告的目的并指明讀者對(duì)象。?
1.2 項(xiàng)目背景：說(shuō)明項(xiàng)目的來(lái)源、委托單位、開(kāi)發(fā)單位及主管部門。?
1.3 定義：列出報(bào)告中所用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的原意。?
1.4參考資料：列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可包括：項(xiàng)目的計(jì)劃任務(wù)書(shū)、合同或批文；項(xiàng)目開(kāi)發(fā)計(jì)劃；需求規(guī)格說(shuō)明 書(shū)；概要設(shè)計(jì)說(shuō)明書(shū)；詳細(xì)設(shè)計(jì)說(shuō)明書(shū)；用戶操作手冊(cè)；測(cè)試計(jì)劃；測(cè)試分析報(bào)告；本報(bào)告引用的其他資料、采用的開(kāi)發(fā)標(biāo)準(zhǔn)或開(kāi)發(fā)規(guī)范。?
2 開(kāi)發(fā)結(jié)果?
2.1 產(chǎn)品：可包括列出各部分的程序名稱、源程序行數(shù)（包括注釋行）或目標(biāo)程序字節(jié)數(shù)及程序總計(jì)數(shù)量、存儲(chǔ)形式；產(chǎn)品文檔名稱等。?
2.2 主要功能及性能?
2.3 所用工時(shí)：按人員的不同層次分別計(jì)時(shí)。?
2.4 所用機(jī)時(shí)：按所用計(jì)算機(jī)機(jī)型分別計(jì)時(shí)。?
2.5 進(jìn)度：給出計(jì)劃進(jìn)度與實(shí)際進(jìn)度的對(duì)比。?
2.6 費(fèi)用?
3 評(píng)價(jià)?
3.1 生產(chǎn)率評(píng)價(jià)：如平均每人每月生產(chǎn)的源程序行數(shù)、文檔的字?jǐn)?shù)等。?
3.2 技術(shù)方案評(píng)價(jià)?
3.3 產(chǎn)品質(zhì)量評(píng)價(jià)?
4 經(jīng)驗(yàn)與教訓(xùn)

軟件維護(hù)手冊(cè)

1 引言?
1.1 編寫(xiě)目的：闡明編寫(xiě)手冊(cè)的目的并指明讀者對(duì)象。?
1.2 項(xiàng)目背景：說(shuō)明項(xiàng)目的提出者、開(kāi)發(fā)者、用戶和使用場(chǎng)所。?
1.3 定義：列出報(bào)告中所用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的原意。?
1.4 參考資料：列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，及保密級(jí)別，可包括：用戶操作手冊(cè)；與本項(xiàng)目有關(guān)的其他文檔。?
2 系統(tǒng)說(shuō)明?
2.1 系統(tǒng)用途：說(shuō)明系統(tǒng)具備的功能，輸入和輸出。?
2.2 安全保密：說(shuō)明系統(tǒng)安全保密方面的考慮。?
2.3 總體說(shuō)明：說(shuō)明系統(tǒng)的總體功能，對(duì)系統(tǒng)、子系統(tǒng)和作業(yè)做出綜合性的介紹，并用圖表的方式給出系統(tǒng)主要部分的內(nèi)部關(guān)系。?
2.4 程序說(shuō)明：說(shuō)明系統(tǒng)中每一程序、分程序的細(xì)節(jié)和特性。?
2.4.1 程序1的說(shuō)明?
● 功能：說(shuō)明程序的功能。?
● 方法：說(shuō)明實(shí)現(xiàn)方法。?
● 輸入：說(shuō)明程序的輸入、媒體、運(yùn)行數(shù)據(jù)記錄、運(yùn)行開(kāi)始時(shí)使用的輸入數(shù)據(jù)的類型和存放單元、與程序初始化有關(guān)的入口要求。?
● 處理：處理特點(diǎn)和目的，如：用圖表說(shuō)明程序的運(yùn)行的邏輯流程；程序主要轉(zhuǎn)移條件；對(duì)程序的約束條件；程序結(jié)束時(shí)的出口要求；與下一個(gè)程序的通信與聯(lián)結(jié)（運(yùn) 行、控制）；由該程序產(chǎn)生并茶館處理程序段使用的輸出數(shù)據(jù)類型和存放單元；程序運(yùn)行存儲(chǔ)量、類型及存儲(chǔ)位置等。?
● 輸出：程序的輸出。?
● 接口：本程序與本系統(tǒng)其他部分的接口。?
●表格：說(shuō)明程序內(nèi)部的各種表、項(xiàng)的細(xì)節(jié)和特性。對(duì)每張表的說(shuō)明至少包括：表的標(biāo)識(shí)符；使用目的；使用此表的其他程序；邏輯劃分，如塊或部，不包括表 項(xiàng)；表的基本結(jié)構(gòu)；設(shè)計(jì)安排，包括表的控制信息。表目結(jié)構(gòu)細(xì)節(jié)、使用中的特有性質(zhì)及各表項(xiàng)的標(biāo)識(shí)、位置、用途、類型、編碼表示。?
● 特有的運(yùn)行性質(zhì)：說(shuō)明在用戶操作手冊(cè)中沒(méi)有提到的運(yùn)行性質(zhì)。?
2.4.2程序2的說(shuō)明?
與程序1的說(shuō)明相同。以后的其他各程序的說(shuō)明相同。?
3 操作環(huán)境?
3.1 設(shè)備：逐項(xiàng)說(shuō)明系統(tǒng)的設(shè)備配置及其特性。?
3.2 支持軟件：列出系統(tǒng)使用的支持軟件，包括它們的名稱和版本號(hào)。?
3.3 數(shù)據(jù)庫(kù)：說(shuō)明每個(gè)數(shù)據(jù)庫(kù)的性質(zhì)和內(nèi)容，包括安全考慮。?
3.3.1總體特征：如標(biāo)識(shí)符、使用這些數(shù)據(jù)庫(kù)的程序、靜態(tài)數(shù)據(jù)、動(dòng)態(tài)數(shù)據(jù)；數(shù)據(jù)庫(kù)的存儲(chǔ)媒體；程序使用數(shù)據(jù)庫(kù)的限制。?
3.3.2結(jié)構(gòu)及詳細(xì)說(shuō)明?
● 說(shuō)明該數(shù)據(jù)庫(kù)的結(jié)構(gòu)，包括其中的記錄和項(xiàng)。?
● 說(shuō)明記錄的組成，包括首部或控制段、記錄體。?
● 說(shuō)明每個(gè)記錄結(jié)構(gòu)的字段，包括：標(biāo)記或標(biāo)號(hào)、字段的字符長(zhǎng)度和位數(shù)、該字段的允許值范圍。?
● 擴(kuò)充：說(shuō)明為記錄追加字段的規(guī)定。?
4 維護(hù)過(guò)程?
4.1 約定：列出該軟件系統(tǒng)設(shè)計(jì)中所使用全部規(guī)則和約定，包括：程序、分程序、記錄、字段和存儲(chǔ)區(qū)的標(biāo)識(shí)或標(biāo)號(hào)助記符的使用規(guī)則；圖表的處理標(biāo)準(zhǔn)、卡片的連接順序、語(yǔ)句和記號(hào)中使用的縮寫(xiě)、出現(xiàn)在圖表中的符號(hào)名；使用的軟件技術(shù)標(biāo)準(zhǔn)；標(biāo)準(zhǔn)化的數(shù)據(jù)元素及其特征。?
4.2 驗(yàn)證過(guò)程：說(shuō)明一個(gè)程序段修改后，對(duì)其進(jìn)行驗(yàn)證的要求和過(guò)程（包括測(cè)試程序和數(shù)據(jù)）及程序周期性驗(yàn)證的過(guò)程。?
4.3 出錯(cuò)及糾正方法：列出出錯(cuò)狀態(tài)及其糾正方法。?
4.4 專門維護(hù)過(guò)程：說(shuō)明文檔其他地方?jīng)]有提到的專門維護(hù)過(guò)程。如：維護(hù)該軟件系統(tǒng)的輸入輸出部分（如數(shù)據(jù)庫(kù)）的要求、過(guò)程和驗(yàn)證方法；運(yùn)行程序庫(kù)維護(hù)系統(tǒng)所必需的要求、過(guò)程和驗(yàn)證方法；對(duì)閏年、世紀(jì)變更的所需要的臨時(shí)性修改等。?
4.5 專用維護(hù)程序：列出維護(hù)軟件系統(tǒng)使用的后備技術(shù)和專用程序（如文件恢復(fù)程序、淘汰過(guò)時(shí)文件的程序等）的目錄，并加以說(shuō)明，內(nèi)容包括：維護(hù)作業(yè)的輸入輸出要求；輸入的詳細(xì)過(guò)程及在硬設(shè)備上建立、運(yùn)行并完成維護(hù)作業(yè)的操作步驟。?
4.6 程序清單和流程圖：引用或提供附錄給出程序清單和流程圖。

軟件問(wèn)題報(bào)告

1 登記號(hào)?
由軟件配置管理部門為該報(bào)告規(guī)定一個(gè)唯一的、順序的編號(hào)。?
2 登記日期?
軟件配置管理部門登記該報(bào)告的日期。?
3 問(wèn)題發(fā)現(xiàn)日期?
發(fā)現(xiàn)該問(wèn)題的日期和時(shí)間。?
4 活動(dòng)?
在哪個(gè)階段發(fā)現(xiàn)的問(wèn)題，分為單元測(cè)試、組裝測(cè)試、確認(rèn)測(cè)試和運(yùn)行維護(hù)。?
5 狀態(tài)?
在軟件配置記錄中維護(hù)的動(dòng)態(tài)指示，狀態(tài)表示有：正在復(fù)查"軟件問(wèn)題報(bào)告"，以確定將采取什么行動(dòng)；"軟件問(wèn)題報(bào)告"已由指定的人去進(jìn)行處理；修改已完 成，并經(jīng)過(guò)測(cè)試，正準(zhǔn)備交給主程序庫(kù)；主程序庫(kù)已經(jīng)更新，主程序庫(kù)修改的重新測(cè)試沿未完成；做了重新測(cè)試，問(wèn)題再現(xiàn)；做了重新測(cè)試，所做的修改無(wú)故障，" 軟件問(wèn)題報(bào)告"被關(guān)閉；留待以后關(guān)閉。?
6 報(bào)告人?
填寫(xiě)"軟件問(wèn)題報(bào)告"人員的姓名、地址、電話。?
7 問(wèn)題屬于什么方面?
區(qū)分是程序的問(wèn)題，還是模塊的問(wèn)題，或是數(shù)據(jù)庫(kù)的問(wèn)題，文件的問(wèn)題。也可能是它們的某種組合。?
8 模塊/子系統(tǒng)?
出現(xiàn)的模塊名。如果不知是哪個(gè)模塊，可標(biāo)出子系統(tǒng)名，盡量給出細(xì)節(jié)。?
9 修訂版本號(hào)?
出現(xiàn)問(wèn)題的模塊版本。?
10 磁帶?
包含有問(wèn)題的模塊的主程序庫(kù)的磁帶的標(biāo)識(shí)符。?
11 數(shù)據(jù)庫(kù)?
當(dāng)發(fā)現(xiàn)問(wèn)題時(shí)所使用數(shù)據(jù)庫(kù)的標(biāo)識(shí)符。?
12 文件號(hào)?
有錯(cuò)誤的文件的編號(hào)。?
13 測(cè)試用例?
發(fā)現(xiàn)錯(cuò)誤時(shí)所使用測(cè)試用例的標(biāo)識(shí)符。?
14 硬件?
發(fā)現(xiàn)錯(cuò)誤時(shí)所使用的計(jì)算機(jī)系統(tǒng)的標(biāo)識(shí)。?
15 問(wèn)題描述/影響?
問(wèn)題癥兆的詳細(xì)描述。如果可能，則寫(xiě)明實(shí)際問(wèn)題所在。也要給出該問(wèn)題對(duì)將來(lái)測(cè)試、接口軟件和文件等的影響。?
16 附注?
記載補(bǔ)充信息。

軟件修改報(bào)告

1 登記號(hào)?
由軟件配置管理部門為該報(bào)告規(guī)定的編號(hào)。?
2 登記日期?
軟件配置管理部門登記"軟件修改報(bào)告"的日期。?
3 時(shí)間?
準(zhǔn)備好"軟件修改報(bào)告"的日期。?
4 報(bào)告人?
填寫(xiě)該報(bào)告的作者。?
5 子系統(tǒng)名?
受修改影響的子系統(tǒng)名。?
6 模塊名?
被修改的模塊名。?
7 "軟件問(wèn)題報(bào)告"的編號(hào)?
被"軟件修改報(bào)告"處理或部分處理的"軟件問(wèn)題報(bào)告"的編號(hào)。如果某"軟件問(wèn)題報(bào)告"的問(wèn)題只是部分被處理，則在編號(hào)后附以p，如1234p。?
8 修改?
包括程序修改、文件更新、數(shù)據(jù)庫(kù)修改或它們的組合。?
9 修改描述?
修改的詳細(xì)描述。如果是文件更新或數(shù)據(jù)庫(kù)修改，還要列出文件更新通知或數(shù)據(jù)庫(kù)修改申請(qǐng)的標(biāo)識(shí)符。?
10 批準(zhǔn)人?
批準(zhǔn)人簽字，正式批準(zhǔn)進(jìn)行修改。?
11 語(yǔ)句類型?
程序修改中涉及到的語(yǔ)句類型，包括：輸入/輸出語(yǔ)句類、計(jì)算語(yǔ)句類、邏輯控制語(yǔ)句類、數(shù)據(jù)處理語(yǔ)句類（如數(shù)據(jù)傳送、存取語(yǔ)句類）。?
12 程序名?
被修改的程序、文件或數(shù)據(jù)庫(kù)的名字。?
13 老修訂版?
當(dāng)前的版本/修訂本標(biāo)識(shí)。?
14 新修訂版?
修改后的版本/修訂本標(biāo)識(shí)。?
15 數(shù)據(jù)庫(kù)?
如果申請(qǐng)數(shù)據(jù)庫(kù)修改，則給出數(shù)據(jù)庫(kù)的標(biāo)識(shí)符。?
16 數(shù)據(jù)庫(kù)修改報(bào)告?
數(shù)據(jù)庫(kù)修改申請(qǐng)?zhí)枴?
17 文件?
如果要求對(duì)文件進(jìn)行修改，則給出文件的名字。?
18 文件更新?
文件更新通知單的編號(hào)。?
19 修改是否已測(cè)試?
指出已對(duì)修改做了哪些測(cè)試，如單元、子系統(tǒng)、組裝、確認(rèn)和運(yùn)行測(cè)試等，并注明測(cè)試成功與否。?
20 "軟件問(wèn)題報(bào)告"是否給出問(wèn)題的準(zhǔn)確描述?
回答'是'或'否'。?
21 問(wèn)題注釋?
準(zhǔn)確地?cái)⑹鲆S護(hù)的問(wèn)題。?
22 問(wèn)題源?
指明問(wèn)題來(lái)自于哪里，如軟件需求說(shuō)明書(shū)、設(shè)計(jì)說(shuō)明書(shū)、數(shù)據(jù)庫(kù)、源程序等。?
23 資源?
完成修改所需資源的估計(jì)，即總的人時(shí)數(shù)和計(jì)算機(jī)時(shí)間的開(kāi)銷。

總結(jié)

以上是生活随笔為你收集整理的软件开发十三种文档格式的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。