前言：

不同顏色代表不同的文檔，本文闡述了軟件開(kāi)發(fā)過(guò)程中十二個(gè)必要文檔的書寫格式與規(guī)范，喜歡的話可以點(diǎn)個(gè)收藏轉(zhuǎn)發(fā)。

軟件文檔編寫指南

目錄

封面格式

系統(tǒng)規(guī)約說(shuō)明書（System Specification）

一．引言

A. 文檔的范圍和目的

B. 概述

1．目標(biāo)

2．約束

二．功能和數(shù)據(jù)描述

A. 系統(tǒng)結(jié)構(gòu)

1．結(jié)構(gòu)關(guān)系圖

2．結(jié)構(gòu)關(guān)系圖描述

三．子系統(tǒng)描述

A. 子系統(tǒng) N 的結(jié)構(gòu)圖規(guī)約說(shuō)明

B. 結(jié)構(gòu)字典

C. 結(jié)構(gòu)連接圖和說(shuō)明

四．系統(tǒng)建模和模擬結(jié)構(gòu)

A. 用于模擬的系統(tǒng)模型

B. 模擬結(jié)果

C. 特殊性能

五．軟件項(xiàng)目問(wèn)題

A. 軟件項(xiàng)目可行性研究報(bào)告

B. 軟件項(xiàng)目計(jì)劃

六．附錄

軟件項(xiàng)目可行性研究報(bào)告

一．引言

1．編寫目的（闡明編寫可行性研究報(bào)告的目的，指出讀者對(duì)象）

2．項(xiàng)目背景（應(yīng)包括：（1）所建議開(kāi)發(fā)的軟件名稱；（2）項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、

用戶及實(shí)現(xiàn)單位；（3）項(xiàng)目與其他軟件或其他系統(tǒng)的關(guān)系。）

3．定義（列出文檔中用到的專門術(shù)語(yǔ)的定義和縮略詞的原文。）

4．參考資料（列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源。）

二．可行性研究的前提

1． 要求（列出并說(shuō)明建議開(kāi)發(fā)軟件的基本要求，如（1）功能；（2）性能；（3）輸出；（4）輸入；（5）基本的數(shù)據(jù)流程和處理流程；（6）安全與保密要求；（7）與軟件相關(guān)的其他系統(tǒng)；（8）完成期限。）

2． 目標(biāo)（可包括：（1）人力與設(shè)備費(fèi)用的節(jié)??；（2）處理速度的提高；（3）控制精度和生產(chǎn)能力的提高；（4）管理信息服務(wù)的改進(jìn)；（5）決策系統(tǒng)的改進(jìn)；（6）人員工作效率的提高，等等。）

3． 條件、假定和限制（可包括：（1）建議開(kāi)發(fā)軟件運(yùn)行的最短壽命；（2）進(jìn)行系統(tǒng)方案選擇比較的期限；（3）經(jīng)費(fèi)來(lái)源和使用限制；（4）法律和政策方面的限制；（5）硬件、軟件、運(yùn)行環(huán)境和開(kāi)發(fā)環(huán)境的條件和限制；（6）可利用的信息和資源；（7）建議開(kāi)發(fā)軟件投入使用的最遲時(shí)間。）

4． 可行性研究方法

5． 決定可行性的主要因素

三．對(duì)現(xiàn)有系統(tǒng)的分析

1．處理流程和數(shù)據(jù)流程

2．工作負(fù)荷

3．費(fèi)用支出（如人力、設(shè)備、空間、支持性服務(wù)、材料等項(xiàng)開(kāi)支。）

4．人員（列出所需人員的專業(yè)技術(shù)類別和數(shù)量。）

5．設(shè)備

6．局限性（說(shuō)明現(xiàn)有系統(tǒng)存在的問(wèn)題以及為什么需要開(kāi)發(fā)新的系統(tǒng)。）

四．所建議技術(shù)可行性分析

1．對(duì)系統(tǒng)的簡(jiǎn)要描述

2．處理流程和數(shù)據(jù)流程

3．與現(xiàn)有系統(tǒng)比較的優(yōu)越性

4．采用建議系統(tǒng)可能帶來(lái)的影響

（1）對(duì)設(shè)備的影響

（2）對(duì)現(xiàn)有軟件的影響

（3）對(duì)用戶的影響

（4）對(duì)系統(tǒng)運(yùn)行的影響

（5）對(duì)開(kāi)發(fā)環(huán)境的影響

（6）對(duì)運(yùn)行環(huán)境的影響

（7）對(duì)經(jīng)費(fèi)支出的影響

5．技術(shù)可行性評(píng)價(jià)（包括：（1）在限制條件下，功能目標(biāo)是否能夠達(dá)到；（2）利用現(xiàn)有軟件文檔編寫指南技術(shù)，功能目標(biāo)能否達(dá)到；（3）對(duì)開(kāi)發(fā)人員數(shù)量和質(zhì)量的要求，并說(shuō)明能否滿足；（4）在規(guī)定的期限內(nèi)，開(kāi)發(fā)能否完成。）

五．所建議系統(tǒng)經(jīng)濟(jì)可行性分析

1．指出

（1）基建投資

（2）其他一次性支出

（3）經(jīng)常性支出

2．效益

（1）一次性收益

（2）經(jīng)常性收益

（3）不可定量收益

3．收益/投資比

4．投資回收周期

5．敏感性分析（指一些關(guān)鍵性因素，如：系統(tǒng)生存周期長(zhǎng)短、系統(tǒng)工作負(fù)荷量、處理速

度要求、設(shè)備和軟件配置變化對(duì)支出和效益的影響等的分析。）

六．社會(huì)因素可行性分析

1．法律因素（如，合同責(zé)任、侵犯專利權(quán)、侵犯版權(quán)等問(wèn)題的分析。）

2．用戶使用可行性（如，用戶單位的行政管理、工作制度、人員素質(zhì)等能否滿足要求。）

七．其他可供選擇的方案（逐個(gè)闡明其他可供選擇的方案，并重點(diǎn)說(shuō)明未被推薦的理由。）

八．結(jié)論意見(jiàn)（可能是：（1）可著手組織開(kāi)發(fā)；（2）需待若干條件（如資金、人力設(shè)備等）具備后才能開(kāi)發(fā)；（3）需對(duì)開(kāi)發(fā)目標(biāo)進(jìn)行某些修改；（4）不能進(jìn)行或不必進(jìn)行（如技術(shù)不成熟，經(jīng)濟(jì)上不合算等）；（4）其他。）

軟件項(xiàng)目計(jì)劃（Software Project Plan）

一．引言

1．編寫目的（闡明編寫軟件計(jì)劃的目的，指出讀者對(duì)象。）

2．項(xiàng)目背景（可包括：（1）項(xiàng)目委托單位、開(kāi)發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其

他系統(tǒng)的關(guān)系。）

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

4．參考資料（可包括：（1）項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文；（2）文

檔所引用的資料、規(guī)范等；列出資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資

料來(lái)源。）

二．項(xiàng)目概述

1. 工作內(nèi)容（簡(jiǎn)要說(shuō)明項(xiàng)目的各項(xiàng)主要工作,介紹所開(kāi)發(fā)軟件的功能 性能等. 若不編寫可

行性研究報(bào)告,則應(yīng)在本節(jié)給出較詳細(xì)的介紹。)

2. 條件與限制（闡明為完成項(xiàng)目應(yīng)具備的條件 開(kāi)發(fā)單位已具備的條件以及尚需創(chuàng)造的條

件. 必要時(shí)還應(yīng)說(shuō)明用戶及分合同承包者承擔(dān)的工作 完成期限及其它條件與限制。）

3. 產(chǎn)品

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

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

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

4．服務(wù)（闡明開(kāi)發(fā)單位可向用戶提供的服務(wù). 如人員培訓(xùn) 安裝 保修 維護(hù)和其他運(yùn)行支

持。）

5．驗(yàn)收標(biāo)準(zhǔn)

三．實(shí)施計(jì)劃

1．任務(wù)分解（任務(wù)的劃分及各項(xiàng)任務(wù)的負(fù)責(zé)人。）

2．進(jìn)度（按階段完成的項(xiàng)目,用圖表說(shuō)明開(kāi)始時(shí)間 完成時(shí)間。）

3．預(yù)算

4．關(guān)鍵問(wèn)題（說(shuō)明可能影響項(xiàng)目的關(guān)鍵問(wèn)題,如設(shè)備條件 技術(shù)難點(diǎn)或其他風(fēng)險(xiǎn)因素,并說(shuō)

明對(duì)策。）

四．人員組織及分工

五．交付期限

六．專題計(jì)劃要點(diǎn)（如測(cè)試計(jì)劃 質(zhì)量保證計(jì)劃 配置管理計(jì)劃 人員培訓(xùn)計(jì)劃 系統(tǒng)安裝計(jì)劃

等。）

需求規(guī)格說(shuō)明書（Requirements Specification）

一．引言

1． 編寫目的（闡明編寫需求說(shuō)明書的目的,指明讀者對(duì)象。）

2． 項(xiàng)目背景（可包括：（1）項(xiàng)目的委托單位,開(kāi)發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其

他系統(tǒng)的關(guān)系。）

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

4． 參考資料（可包括：（1）項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書,合同或上機(jī)機(jī)關(guān)的批文；（2）項(xiàng)目

開(kāi)發(fā)計(jì)劃；（3）文檔所引用的資料，標(biāo)準(zhǔn)和規(guī)范。列出這些資料的作者、標(biāo)題、編號(hào)、

發(fā)表日期、出版單位或資料來(lái)源。）

二．任務(wù)概述

1．目標(biāo)

2．運(yùn)行環(huán)境

3．條件與限制

三．?dāng)?shù)據(jù)描述

1． 靜態(tài)數(shù)據(jù)

2． 動(dòng)態(tài)數(shù)據(jù)（包括輸入數(shù)據(jù)和輸出數(shù)據(jù)。）

3． 數(shù)據(jù)庫(kù)描述（給出使用數(shù)據(jù)庫(kù)的名稱和類型。）

4． 數(shù)據(jù)詞典

5． 數(shù)據(jù)采集

四．功能需求

1．功能劃分

2．功能描述

五．性能需求

1．?dāng)?shù)據(jù)精確度

2．時(shí)間特性（如響應(yīng)時(shí)間、更新處理時(shí)間、數(shù)據(jù)轉(zhuǎn)化與傳輸時(shí)間、運(yùn)行時(shí)間等。）

3．適應(yīng)性（在操作方式 運(yùn)行環(huán)境 與其他軟件的接口以及開(kāi)發(fā)計(jì)劃等發(fā)生變化時(shí)，應(yīng)具

有的適應(yīng)能力。）

六．運(yùn)行需求

1．用戶界面（如屏幕格式、報(bào)表格式、菜單格式、輸入輸出時(shí)間等。）

2．硬件接口

3．軟件接口

4．故障處理

七．其他需求（如可使用性、安全保密、可維護(hù)性、可移植性等。）

概要設(shè)計(jì)說(shuō)明書（Architectural Design Specification）

一．引言

1．編寫目的（闡明編寫概要設(shè)計(jì)說(shuō)明書的目的，指明讀者對(duì)象。）

2．項(xiàng)目背景（可包括：（1）項(xiàng)目的委托單位,開(kāi)發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其

他系統(tǒng)的關(guān)系。）

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

4．參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可

包括：（1）項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書，合同或上機(jī)機(jī)關(guān)的批文；（2）項(xiàng)目開(kāi)發(fā)計(jì)劃；

（3）需求規(guī)格說(shuō)明書；（4）測(cè)試計(jì)劃（初稿）；（5）用戶操作手冊(cè)（初稿）；（6）文檔

所引用的資料、采用的標(biāo)準(zhǔn)或規(guī)范。）

二．任務(wù)概述

1．目標(biāo)

2．運(yùn)行環(huán)境

3．需求概述

4．條件與限制

三．總體設(shè)計(jì)

1．處理流程

2．總體結(jié)構(gòu)和模塊外部設(shè)計(jì)

3．功能分配（表明各項(xiàng)功能與程序結(jié)構(gòu)的關(guān)系。）

四．接口設(shè)計(jì)

1．外部接口（包括用戶界面 軟件接口與硬件接口。）

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

五．?dāng)?shù)據(jù)結(jié)構(gòu)設(shè)計(jì)

1． 邏輯結(jié)構(gòu)設(shè)計(jì)

2． 物理結(jié)構(gòu)設(shè)計(jì)

3． 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系

六．運(yùn)行設(shè)計(jì)

1．運(yùn)行模塊的組合

2．運(yùn)行控制

3．運(yùn)行時(shí)間

七．出錯(cuò)處理設(shè)計(jì)

1．出錯(cuò)輸出信息

2．出錯(cuò)處理對(duì)策（如設(shè)置后備、性能降級(jí)、恢復(fù)及再啟動(dòng)等。）

八．安全保密設(shè)計(jì)

九．維護(hù)設(shè)計(jì)（說(shuō)明為方便維護(hù)工作的設(shè)施,如維護(hù)模塊等。）

詳細(xì)設(shè)計(jì)說(shuō)明書（Procedural Design Specification）

一．引言

1． 編寫目的（闡明編寫詳細(xì)設(shè)計(jì)說(shuō)明書的目的,指明讀者對(duì)象。）

2． 項(xiàng)目背景（應(yīng)包括項(xiàng)目的來(lái)源和主管部門等。）

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

4． 參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可

包括：（1）項(xiàng)目的計(jì)劃任務(wù)書,合同或批文；（2）項(xiàng)目開(kāi)發(fā)計(jì)劃；（3）需求規(guī)格說(shuō)明書；

（3）概要設(shè)計(jì)說(shuō)明書；（4）測(cè)試計(jì)劃(初稿)；（5）用戶操作手冊(cè)(初稿)；（5）文檔所

引用的其他資料、軟件開(kāi)發(fā)標(biāo)準(zhǔn)或規(guī)范。）

二．總體設(shè)計(jì)

1．需求概述

2．軟件結(jié)構(gòu)（如給出軟件系統(tǒng)的結(jié)果圖。）

三．程序描述（逐個(gè)模塊給出以下的說(shuō)明:：）

1．功能

2．性能

3．輸入項(xiàng)目

4．輸出項(xiàng)目

5．算法（模塊所選用的算法。）

6．程序邏輯（詳細(xì)描述模塊實(shí)現(xiàn)的算法，可采用:：（1）標(biāo)準(zhǔn)流程圖；（2）PDL 語(yǔ)言；（3）N-S 圖；（4）PAD；（5）判定表等描述算法的圖表。）

7．接口

8．存儲(chǔ)分配

9．限制條件

10． 測(cè)試要點(diǎn)（給出測(cè)試模塊的主要測(cè)試要求。）

用戶操作手冊(cè)（User Guide）

一．引言

1．編寫目的（闡明編寫手冊(cè)的目的，指明讀者對(duì)象。）

2．項(xiàng)目背景（說(shuō)明項(xiàng)目的來(lái)源、委托單位、開(kāi)發(fā)單位及主管部門。）

3．定義（列出手冊(cè)中用到的專門術(shù)語(yǔ)定義和縮寫詞的原意。）

4．參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可

包括：（1）項(xiàng)目的計(jì)劃任務(wù)書,合同或批文；（2）項(xiàng)目開(kāi)發(fā)計(jì)劃；（3）需求規(guī)格說(shuō)明書；

（4）概要設(shè)計(jì)說(shuō)明書；（5）詳細(xì)設(shè)計(jì)說(shuō)明書；（6）測(cè)試計(jì)劃；（7）手冊(cè)中引用的其他

資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。）

二．軟件概述

1．目標(biāo)

2．功能

3．性能

（1）數(shù)據(jù)精確度（包括輸入、輸出及處理數(shù)據(jù)的精度。）

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

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

三．運(yùn)行環(huán)境

1．硬件（列出軟件系統(tǒng)運(yùn)行時(shí)所需的硬件最小配置，如：（1）計(jì)算機(jī)型號(hào)、主存容量；

（2）外存儲(chǔ)器、媒體、記錄格式、設(shè)備型號(hào)及數(shù)量；（3）輸入、輸出設(shè)備；（4）數(shù)據(jù)

傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號(hào)及數(shù)量。）

2．支持軟件（如：（1）操作系統(tǒng)名稱及版本號(hào)；（2）語(yǔ)言編譯系統(tǒng)或匯編系統(tǒng)的名稱及

版本號(hào)；（3）數(shù)據(jù)庫(kù)管理系統(tǒng)的名稱及版本號(hào)；（4）其他必要的支持軟件。）

四．使用說(shuō)明

1．安裝和初始化（給出程序的存儲(chǔ)形式、操作命令、反饋信息及其含義、表明安裝完成

的測(cè)試實(shí)例以及安裝所需的軟件工具等。）

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

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

（2）數(shù)據(jù)格式（如：（1）長(zhǎng)度（2）格式基準(zhǔn)（3）標(biāo)號(hào)（4）順序（5）分隔符（6）

詞匯表（7）省略和重復(fù)（8）控制。）

（3）輸入舉例

3．輸出（給出每項(xiàng)輸出數(shù)據(jù)的說(shuō)明。）

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

（2）數(shù)據(jù)格式（詳細(xì)闡明每一輸出數(shù)據(jù)的格式,如:首部 主體和尾部的具體形式。）

（3）舉例

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

再啟動(dòng)。）

4．求助查詢（說(shuō)明如何操作。）

五．運(yùn)行說(shuō)明

1． 運(yùn)行表 [列出每種可能的運(yùn)行情況,說(shuō)明其運(yùn)行目的.]

2． 運(yùn)行步驟 [按順序說(shuō)明每種運(yùn)行的步驟,應(yīng)包括:]

軟件文檔編寫指南

（1） 運(yùn)行控制

（2） 操作信息（（1）運(yùn)行目的（2）操作要求（3）啟動(dòng)方法（4）預(yù)計(jì)運(yùn)行時(shí)間（5）

操作命令格式及說(shuō)明（6）其他事項(xiàng)。）

（3） 輸入/輸出文件（給出建立和更新文件的有關(guān)信息，如：（1）文件的名稱及編

號(hào)（2）記錄媒體（3）存留的目錄（4）文件的支配[說(shuō)明確定保留文件或廢棄

文件的準(zhǔn)則，分發(fā)文件的對(duì)象，占用硬件的優(yōu)先級(jí)及保密控制等。）

（4） 啟動(dòng)或恢復(fù)過(guò)程

六．非常規(guī)過(guò)程（提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯(cuò)處理操作、向后備

系統(tǒng)切換操作以及維護(hù)人員須知的操作和注意事項(xiàng)。）

七．操作命令一覽表

（按字母順序逐個(gè)列出全部操作命令的格式 功能及參數(shù)說(shuō)明。）

八．程序文件（或命令文件）和數(shù)據(jù)文件一覽表（按文件名字母順序或按功能與模塊分類順

序逐個(gè)列出文件名稱、標(biāo)識(shí)符及說(shuō)明。）

九．用戶操作舉例

測(cè)試計(jì)劃（Test Plan）

一、引言

1． 編寫目的（闡明編寫測(cè)試計(jì)劃的目的,指明讀者對(duì)象。）

2． 項(xiàng)目背景（說(shuō)明項(xiàng)目的來(lái)源 委托單位及主管部門。）

3． 定義（列出測(cè)試計(jì)劃中用到的專門術(shù)語(yǔ)定義和縮寫詞的原意。）

4． 參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可

包括：（1）項(xiàng)目的計(jì)劃任務(wù)書，合同或批文；（2）項(xiàng)目開(kāi)發(fā)計(jì)劃；（3）需求規(guī)格說(shuō)明

書；（3）概要設(shè)計(jì)說(shuō)明書；（4）詳細(xì)設(shè)計(jì)說(shuō)明書；（5）用戶操作手冊(cè); g 本測(cè)試計(jì)劃中

引用的其他資料 采用的軟件開(kāi)發(fā)標(biāo)準(zhǔn)或規(guī)范。）

二．任務(wù)概述

1．目標(biāo)

2．運(yùn)行環(huán)境

3．需求概述

4．條件與限制

三．計(jì)劃

1．測(cè)試方案（說(shuō)明確定測(cè)試方法和選取測(cè)試用例的原則。）

2．測(cè)試項(xiàng)目（列出組裝測(cè)試和確認(rèn)測(cè)試中每一項(xiàng)測(cè)試的內(nèi)容、名稱、目的和進(jìn)度。）

3．測(cè)試準(zhǔn)備

4．測(cè)試機(jī)構(gòu)及人員（測(cè)試機(jī)構(gòu)名稱 負(fù)責(zé)人和職責(zé)。）

四．測(cè)試項(xiàng)目說(shuō)明（按順序逐個(gè)對(duì)測(cè)試項(xiàng)目做出說(shuō)明：）

1．測(cè)試項(xiàng)目名稱及測(cè)試內(nèi)容

2．測(cè)試用例

（1）輸入（輸入的數(shù)據(jù)和輸入的命令。）

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

（3）步驟及操作

（4）允許偏差（給出實(shí)測(cè)結(jié)果與預(yù)測(cè)結(jié)果之間允許偏差的范圍。）

3． 進(jìn)度

4． 條件（給出項(xiàng)測(cè)試對(duì)資源的特殊要求，如設(shè)備、軟件、人員等。）

5． 測(cè)試資料（說(shuō)明項(xiàng)測(cè)試所需的資料。）

五．評(píng)價(jià)

1．范圍（說(shuō)明所完成的各項(xiàng)測(cè)試說(shuō)明問(wèn)題的范圍及其局限性。）

2．準(zhǔn)則（說(shuō)明評(píng)價(jià)測(cè)試結(jié)果的準(zhǔn)則。）

測(cè)試分析報(bào)告（Test Specification）

一．引言

1．編寫目的（闡明編寫測(cè)試分析報(bào)告的目的，指明讀者對(duì)象。）

2．項(xiàng)目背景（說(shuō)明項(xiàng)目的來(lái)源、委托單位及主管部門。）

3．定義（列出測(cè)試分析報(bào)告中用到的專門術(shù)語(yǔ)定義和縮寫詞的原意。）

4．參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可

包括：（1）項(xiàng)目的計(jì)劃任務(wù)書，合同或批文；（2）項(xiàng)目開(kāi)發(fā)計(jì)劃；（3）需求規(guī)格說(shuō)明

書；（4）概要設(shè)計(jì)說(shuō)明書；（5）詳細(xì)設(shè)計(jì)說(shuō)明書；（6）用戶操作手冊(cè)；（7）測(cè)試計(jì)劃；

（8）測(cè)試分析報(bào)告所引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。）

二．測(cè)試計(jì)劃執(zhí)行情況

1．測(cè)試項(xiàng)目（列出每一測(cè)試項(xiàng)目的名稱、內(nèi)容和目的。）

2．測(cè)試機(jī)構(gòu)和人員（給出測(cè)試機(jī)構(gòu)名稱、負(fù)責(zé)人和參與測(cè)試人員名單。）

3．測(cè)試結(jié)果（按順序給出每一測(cè)試項(xiàng)目的：（1）實(shí)測(cè)結(jié)果數(shù)據(jù)（2）與預(yù)期結(jié)果數(shù)據(jù)的偏

差（3）該項(xiàng)測(cè)試說(shuō)明的事實(shí)（4）該項(xiàng)測(cè)試發(fā)現(xiàn)的問(wèn)題。）

三．軟件需求測(cè)試結(jié)論（按順序給出每一項(xiàng)需求測(cè)試的結(jié)論。包括：（1）證實(shí)的軟件能力（2）

局限性（即項(xiàng)需求未得到充分測(cè)試的情況及原因）。）

四．評(píng)價(jià)

1．軟件能力（經(jīng)過(guò)測(cè)試所表明的軟件能力。）

2．缺陷和限制（說(shuō)明測(cè)試所揭露的軟件缺陷和不足,以及可能給軟件運(yùn)行帶來(lái)的影響。）

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

4．測(cè)試結(jié)論（說(shuō)明能否通過(guò)。）

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

一．報(bào)告時(shí)間及所處的開(kāi)發(fā)階段

二．給出進(jìn)度

1． 本月內(nèi)的主要活動(dòng)

2． 實(shí)際進(jìn)展與計(jì)劃比較

三．所用工時(shí)（按不同層次人員分別計(jì)時(shí)。）

四．所有機(jī)時(shí)（按所有計(jì)算機(jī)機(jī)型分別計(jì)時(shí)。）

五．經(jīng)費(fèi)支出（分類列出本月經(jīng)費(fèi)支出項(xiàng)目,給出支出總額，并與計(jì)劃比較。）

六．工作遇到的問(wèn)題及采取的對(duì)策

七．本月完成的成果

八．下月的工作計(jì)劃

九．特殊問(wèn)題

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

一．引言

1．編寫目的（闡明編寫總結(jié)報(bào)告的目的,指明讀者對(duì)象。）

2．項(xiàng)目背景（說(shuō)明項(xiàng)目的來(lái)源、委托單位、開(kāi)發(fā)單位及主管部門。）

3．定義（列出報(bào)告中用到的專門術(shù)語(yǔ)定義和縮寫詞的原意。）

4．參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可

包括：（1）項(xiàng)目的計(jì)劃任務(wù)書，合同或批文；（2）項(xiàng)目開(kāi)發(fā)計(jì)劃；（3）需求規(guī)格說(shuō)明

書；（4）概要設(shè)計(jì)說(shuō)明書；（5）詳細(xì)設(shè)計(jì)說(shuō)明書；（6）用戶操作手冊(cè)；（7）測(cè)試計(jì)劃；

（8）測(cè)試分析報(bào)告（9）本報(bào)告引用的其他資料、采用的開(kāi)發(fā)標(biāo)準(zhǔn)或開(kāi)發(fā)規(guī)范。）

二．開(kāi)發(fā)結(jié)果

1． 產(chǎn)品（可包括：（1）列出各部分的程序名稱、源程序行數(shù)（包括注釋行）或目標(biāo)程序

字節(jié)數(shù)及程序總計(jì)數(shù)量、存儲(chǔ)形式；產(chǎn)品文檔名稱等。）

2． 主要功能及性能

3． 所用工時(shí)（按人員的不同層次分別計(jì)時(shí)。）

4． 所用機(jī)時(shí)（按所用計(jì)算機(jī)機(jī)型分別計(jì)時(shí)。）

5． 進(jìn)度（給出計(jì)劃進(jìn)度與實(shí)際進(jìn)度的對(duì)比。）

6． 費(fèi)用

三．評(píng)價(jià)

1．生產(chǎn)率評(píng)價(jià)（如平均每人每月生產(chǎn)的源程序行數(shù)、文檔的字?jǐn)?shù)等。）

2．技術(shù)方案評(píng)價(jià)

3．產(chǎn)品質(zhì)量評(píng)價(jià)

四．經(jīng)驗(yàn)與教訓(xùn)

軟件修改報(bào)告

一．登記號(hào)（由軟件配置管理部門為該報(bào)告規(guī)定的編號(hào)。）

二．登記日期（軟件配置管理部門登記”軟件修改報(bào)告”的日期。）

三．時(shí)間（準(zhǔn)備好”軟件修改報(bào)告”的日期。）

四．報(bào)告人（填寫該報(bào)告的作者。）

五．子系統(tǒng)名（受修改影響的子系統(tǒng)名。）

六．模塊名（被修改的模塊名。）

七．“軟件問(wèn)題報(bào)告”的編號(hào)（被”軟件修改報(bào)告”處理或部分處理的”軟件問(wèn)題報(bào)告”的編號(hào)。）

八．修改（包括程序修改、文件更新、數(shù)據(jù)庫(kù)修改或他們的組合。）

九．修改描述（修改的詳細(xì)描述。如果是文件更新或數(shù)據(jù)庫(kù)修改，還要列出文件更新通知或

數(shù)據(jù)庫(kù)修改申請(qǐng)的標(biāo)識(shí)符。）

十．批準(zhǔn)人（批準(zhǔn)人簽字，正式批準(zhǔn)進(jìn)行修改。）

十一． 語(yǔ)句類型（程序修改中涉及到的語(yǔ)句類型，包括：輸入/輸出語(yǔ)句類、計(jì)算語(yǔ)句類、

邏輯控制語(yǔ)句類、數(shù)據(jù)處理語(yǔ)句類(如數(shù)據(jù)傳送 存取語(yǔ)句類)。）

十二． 程序名（被修改的程序、文件或數(shù)據(jù)庫(kù)名字。）

十三． 老修訂版（當(dāng)前的版本/修訂本標(biāo)識(shí)。）

十四． 新修訂版（修改后的版本/修訂本標(biāo)識(shí)。）

十五． 數(shù)據(jù)庫(kù)（如果申請(qǐng)數(shù)據(jù)庫(kù)修改,則給出數(shù)據(jù)庫(kù)的標(biāo)識(shí)符。）

十六． 數(shù)據(jù)庫(kù)修改報(bào)告（數(shù)據(jù)庫(kù)修改申請(qǐng)?zhí)?。?/span>

十七． 文件（如果要求對(duì)文件進(jìn)行修改，則給出文件的名字。）

十八． 文件更新（文件更新通知單的編號(hào)。）

十九． 修改是否已測(cè)試（指出已對(duì)修改做了哪些測(cè)試，如單元、子系統(tǒng)、組裝、確認(rèn)和運(yùn)

行測(cè)試等，并注明測(cè)試成功與否。）

二十． “軟件問(wèn)題報(bào)告”是否給出問(wèn)題的準(zhǔn)確描述

二十一． 題注釋（準(zhǔn)確地?cái)⑹鲆S護(hù)的問(wèn)題。）

二十二． 題源（指明問(wèn)題來(lái)自于哪里。）

二十三． 源（完成修改所需資源的估計(jì)，即總的人時(shí)數(shù)和計(jì)算機(jī)時(shí)間的開(kāi)銷。）