|
文檔分類
項(xiàng)目包括如下幾類文檔；
項(xiàng)目管理文檔。包括：《軟件項(xiàng)目計(jì)劃》、《項(xiàng)目進(jìn)度報(bào)告》、《項(xiàng)目開發(fā)總結(jié)報(bào)告》
軟件開發(fā)文檔。包括：《需求規(guī)格說明》、《概要設(shè)計(jì)說明》、《詳細(xì)設(shè)計(jì)說明》。
軟件測試文檔。包括：《測試計(jì)劃》、《軟件測試分析報(bào)告》。
產(chǎn)品資料。包括：《用戶操作手冊》。
本項(xiàng)目文檔的版本號由以圓點(diǎn)隔開的兩個數(shù)字組成，第一個數(shù)字表示出版號，第二個數(shù)字表示該版的修訂號。具體用法如下：
當(dāng)文檔初版時，版本號為 V1.0；
當(dāng)文檔被局部修訂時，出版號不變，修訂號增1。例如，對初版文檔作了第一次修訂，則版本號為 V1.1；
當(dāng)文檔被全面改寫或局部修訂累積較多導(dǎo)致文檔發(fā)生全局變化時，出版號增1。例如，在 V1.5 版的基礎(chǔ)上作了一次全面修訂，則新版本號為 V2.0。
項(xiàng)目所產(chǎn)生的文檔都有唯一、特定的編碼，其構(gòu)成如下：
項(xiàng)目標(biāo)志-任務(wù)標(biāo)識-文檔類型-文檔樹中的編號-版本號/序號
其中：
項(xiàng)目標(biāo)志：本項(xiàng)目的標(biāo)識，表明本項(xiàng)目是“XXXX”。
任務(wù)標(biāo)識：少于八個字母，簡要標(biāo)識本任務(wù)，標(biāo)準(zhǔn)XXXX是“STANDARD”。適用于整個項(xiàng)目的文檔，此標(biāo)識為“XXXX”。
文檔類型：取自下表的兩位字母編碼。
編號：反映文檔類型（根據(jù)下表填寫）
版本號：本文檔的版本號。
序號：四位數(shù)字編碼，指明該文檔在項(xiàng)目文檔庫的總序號。
一個文檔編碼的例子為：
XXXX-XXXX-SP-2N01-V1.0/0015
表5.3 項(xiàng)目的文檔分類表
本項(xiàng)目中所有文檔的標(biāo)識清單將在《項(xiàng)目開發(fā)計(jì)劃》中予以具體定義。
本項(xiàng)目中所有任務(wù)的文檔將按照統(tǒng)一的模板（格式和內(nèi)容的約定）來編寫，包括：
《模板-軟件開發(fā)計(jì)劃》
《模板-軟件需求規(guī)格說明》
《模板-軟件設(shè)計(jì)說明》
《模板-技術(shù)說明》
文檔的模板均保存在配置管理員處，并由其分發(fā)給文檔的編寫者。
需要說明的是，文檔模板是本項(xiàng)目在文檔結(jié)構(gòu)和版式上的統(tǒng)一約定，對于具體文檔，編寫者可以根據(jù)需要添加章節(jié)，原則上不要刪除章節(jié)（可以寫“本章/節(jié)無內(nèi)容”）。當(dāng)文檔模板不符合編寫者要求時，編寫者應(yīng)與項(xiàng)目組長聯(lián)系以決定文檔的編寫標(biāo)準(zhǔn)。
在 產(chǎn)品包中，應(yīng)包含一份《技術(shù)說明》，以詳細(xì)說明本產(chǎn)品的代碼來源和修改情況。
在《技術(shù)說明》中，應(yīng)包含如下內(nèi)容：
代碼包的清單，格式為：
其中，“來源”可以是：下載的網(wǎng)絡(luò)地址、“拷貝”、“創(chuàng)建”
代碼文件的清單，格式為：
其中，“狀態(tài)”可以是：“修改”、“刪除”、“創(chuàng)建”、“原樣”
封面格式：
文檔編號
版 本 號
文檔名稱：
項(xiàng)目名稱：
項(xiàng)目負(fù)責(zé)人：
編寫 年 月 日
校對 年 月 日
審核 年 月 日
批準(zhǔn) 年 月 日
開發(fā)單位
系統(tǒng)規(guī)格說明書（System Specification）
一．引言
A. 文檔的范圍和目的
B. 概述
1．目標(biāo)
二．功能和數(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)的結(jié)構(gòu)圖規(guī)格說明
B. 結(jié)構(gòu)字典
C. 結(jié)構(gòu)連接圖和說明
四．系統(tǒng)建模和模擬結(jié)構(gòu)
A. 用于模擬的系統(tǒng)模型
B. 模擬結(jié)果
C. 特殊性能
五．軟件項(xiàng)目問題
A. 軟件項(xiàng)目計(jì)劃
六．附錄
軟件項(xiàng)目計(jì)劃（Software Project Plan）
一．引言
1．編寫目的（闡明編寫軟件計(jì)劃的目的，指出讀者對象。）
2．項(xiàng)目背景（可包括：（1）項(xiàng)目委托單位、開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）
3．定義（列出本文檔中用到的專門術(shù)語的定義和縮略詞的原文。）
4．參考資料（可包括：文檔所引用的資料、規(guī)范等；列出資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源。）
二．項(xiàng)目概述
1. 工作內(nèi)容（簡要說明項(xiàng)目的各項(xiàng)主要工作,介紹所開發(fā)軟件的功能 性能等. 若不編寫可行性研究報(bào)告,則應(yīng)在本節(jié)給出較詳細(xì)的介紹。)
2. 條件與限制（闡明為完成項(xiàng)目應(yīng)具備的條件 開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件. 必要時還應(yīng)說明用戶及分合同承包者承擔(dān)的工作 完成期限及其它條件與限制。）
3. 產(chǎn)品
（1）程序（列出應(yīng)交付的程序名稱 使用的語言及存儲形式。）
（2）文檔（列出應(yīng)交付的文檔。）
（3）運(yùn)行環(huán)境（應(yīng)包括硬件環(huán)境 軟件環(huán)境。）
4．服務(wù)（闡明開發(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)目,用圖表說明開始時間 完成時間。）
3．預(yù)算
4．關(guān)鍵問題（說明可能影響項(xiàng)目的關(guān)鍵問題,如設(shè)備條件 技術(shù)難點(diǎn)或其他風(fēng)險因素,并說明對策。）
四．人員組織及分工
五．交付期限
六．專題計(jì)劃要點(diǎn)（如測試計(jì)劃等。）
需求規(guī)格說明書（Requirements Specification）
一．引言
1． 編寫目的（闡明編寫需求說明書的目的,指明讀者對象。）
2． 項(xiàng)目背景（可包括：（1）項(xiàng)目的委托單位,開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）
3． 定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原文。）
4． 參考資料（可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）文檔所引用的資料，標(biāo)準(zhǔn)和規(guī)范。列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源。）
二．任務(wù)概述
1．目標(biāo)
2．運(yùn)行環(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)化與傳輸時間、運(yùn)行時間等。）
3．適應(yīng)性（在操作方式 運(yùn)行環(huán)境 與其他軟件的接口以及開發(fā)計(jì)劃等發(fā)生變化時，應(yīng)具有的適應(yīng)能力。）
六．運(yùn)行需求
1．用戶界面（如屏幕格式、報(bào)表格式、菜單格式、輸入輸出時間等。）
2．硬件接口
3．軟件接口
4．故障處理
七．其他需求（如可使用性、安全保密、可維護(hù)性、可移植性等。）
概要設(shè)計(jì)說明書（Architectural Design Specification）
一．引言
1．編寫目的（闡明編寫概要設(shè)計(jì)說明書的目的，指明讀者對象。）
2．項(xiàng)目背景（可包括：（1）項(xiàng)目的委托單位,開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）
3．定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原意。）
4．參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）測試計(jì)劃（初稿）；（4）用戶操作手冊（初稿）；（5）文檔所引用的資料、采用的標(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)部接口（模塊之間的接口。）
五．數(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è)計(jì)
1．出錯輸出信息
2．出錯處理對策（如設(shè)置后備、性能降級、恢復(fù)及再啟動等。）
八．安全保密設(shè)計(jì)
九．維護(hù)設(shè)計(jì)（說明為方便維護(hù)工作的設(shè)施,如維護(hù)模塊等。）
詳細(xì)設(shè)計(jì)說明書（Procedural Design Specification）
一．引言
1． 編寫目的（闡明編寫詳細(xì)設(shè)計(jì)說明書的目的,指明讀者對象。）
2． 項(xiàng)目背景（應(yīng)包括項(xiàng)目的來源和主管部門等。）
3． 定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原意。）
4． 參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；（4）測試計(jì)劃(初稿)；（5）用戶操作手冊(初稿)；（5）文檔所引用的其他資料、軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。）
二．總體設(shè)計(jì)
1．需求概述
2．軟件結(jié)構(gòu)（如給出軟件系統(tǒng)的結(jié)果圖。）
三．程序描述（逐個模塊給出以下的說明:：）
1．功能
2．性能
3．輸入項(xiàng)目
4．輸出項(xiàng)目
5．算法（模塊所選用的算法。）
6．程序邏輯（詳細(xì)描述模塊實(shí)現(xiàn)的算法，可采用:：（1）標(biāo)準(zhǔn)流程圖；（2）N-S圖；（3）PAD；（4）判定表等描述算法的圖表。）
7．接口
8．存儲分配
9．限制條件
10． 測試要點(diǎn)（給出測試模塊的主要測試要求。）
用戶操作手冊（User Guide）
一．引言
1．編寫目的（闡明編寫手冊的目的，指明讀者對象。）
2．項(xiàng)目背景（說明項(xiàng)目的來源、委托單位、開發(fā)單位及主管部門。）
3．定義（列出手冊中用到的專門術(shù)語定義和縮寫詞的原意。）
4．參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；（4）詳細(xì)設(shè)計(jì)說明書；（5）測試計(jì)劃；（6）手冊中引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。）
二．軟件概述
1．目標(biāo)
2．功能
3．性能
（1）數(shù)據(jù)精確度（包括輸入、輸出及處理數(shù)據(jù)的精度。）
（2）時間特性（如響應(yīng)時間、處理時間、數(shù)據(jù)傳輸時間等。）
（3）靈活性（在操作方式、運(yùn)行環(huán)境需做某些變更時軟件的適應(yīng)能力。）
三．運(yùn)行環(huán)境
1．硬件（列出軟件系統(tǒng)運(yùn)行時所需的硬件最小配置，如：（1）計(jì)算機(jī)型號、主存容量；（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．安裝和初始化（給出程序的存儲形式、操作命令、反饋信息及其含義、表明安裝完成的測試實(shí)例以及安裝所需的軟件工具等。）
2．輸入（給出輸入數(shù)據(jù)或參數(shù)的要求。）
（1）數(shù)據(jù)背景（說明數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。）
（2）數(shù)據(jù)格式（如：（1）長度（2）格式基準(zhǔn)（3）標(biāo)號（4）順序（5）分隔符（6）詞匯表（7）省略和重復(fù)（8）控制。）
（3）輸入舉例
3．輸出（給出每項(xiàng)輸出數(shù)據(jù)的說明。）
（1）數(shù)據(jù)背景（說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。）
（2）數(shù)據(jù)格式（詳細(xì)闡明每一輸出數(shù)據(jù)的格式,如:首部 主體和尾部的具體形式。）
（3）舉例
3．出錯和恢復(fù)（給出：（1）出錯信息及其含義（2）用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動。）
4．求助查詢（說明如何操作。）
五．運(yùn)行說明
1． 運(yùn)行表 [列出每種可能的運(yùn)行情況,說明其運(yùn)行目的.]
2． 運(yùn)行步驟 [按順序說明每種運(yùn)行的步驟,應(yīng)包括:]
（1） 運(yùn)行控制
（2） 操作信息（（1）運(yùn)行目的（2）操作要求（3）啟動方法（4）預(yù)計(jì)運(yùn)行時間（5）操作命令格式及說明（6）其他事項(xiàng)。）
（3） 輸入/輸出文件（給出建立和更新文件的有關(guān)信息，如：（1）文件的名稱及編號（2）記錄媒體（3）存留的目錄（4）文件的支配[說明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對象，占用硬件的優(yōu)先級及保密控制等。）
（4） 啟動或恢復(fù)過程
六．非常規(guī)過程（提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯處理操作、向后備系統(tǒng)切換操作以及維護(hù)人員須知的操作和注意事項(xiàng)。）
七．操作命令一覽表
（按字母順序逐個列出全部操作命令的格式 功能及參數(shù)說明。）
八．程序文件（或命令文件）和數(shù)據(jù)文件一覽表（按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標(biāo)識符及說明。）
九．用戶操作舉例
測試計(jì)劃（Test Plan）
一、引言
1． 編寫目的（闡明編寫測試計(jì)劃的目的,指明讀者對象。）
2． 項(xiàng)目背景（說明項(xiàng)目的來源 委托單位及主管部門。）
3． 定義（列出測試計(jì)劃中用到的專門術(shù)語定義和縮寫詞的原意。）
4． 參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；（4）詳細(xì)設(shè)計(jì)說明書；（5）用戶操作手冊; (6) 本測試計(jì)劃中引用的其他資料 采用的軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。）
二．任務(wù)概述
1．目標(biāo)
2．運(yùn)行環(huán)境
3．需求概述
4．條件與限制
三．計(jì)劃
1．測試方案（說明確定測試方法和選取測試用例的原則。）
2．測試項(xiàng)目（列出組裝測試和確認(rèn)測試中每一項(xiàng)測試的內(nèi)容、名稱、目的和進(jìn)度。）
3．測試準(zhǔn)備
4．測試機(jī)構(gòu)及人員（測試機(jī)構(gòu)名稱 負(fù)責(zé)人和職責(zé)。）
四．測試項(xiàng)目說明（按順序逐個對測試項(xiàng)目做出說明：）
1．測試項(xiàng)目名稱及測試內(nèi)容
2．測試用例
（1）輸入（輸入的數(shù)據(jù)和輸入的命令。）
（2）輸出（預(yù)期的輸出數(shù)據(jù)。）
（3）步驟及操作
（4）允許偏差（給出實(shí)測結(jié)果與預(yù)測結(jié)果之間允許偏差的范圍。）
3． 進(jìn)度
4． 條件（給出項(xiàng)測試對資源的特殊要求，如設(shè)備、軟件、人員等。）
5． 測試資料（說明項(xiàng)測試所需的資料。）
五．評價
1．范圍（說明所完成的各項(xiàng)測試說明問題的范圍及其局限性。）
2．準(zhǔn)則（說明評價測試結(jié)果的準(zhǔn)則。）
測試分析報(bào)告（Test Specification）
一．引言
1．編寫目的（闡明編寫測試分析報(bào)告的目的，指明讀者對象。）
2．項(xiàng)目背景（說明項(xiàng)目的來源、委托單位及主管部門。）
3．定義（列出測試分析報(bào)告中用到的專門術(shù)語定義和縮寫詞的原意。）
4．參
考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；
（4）詳細(xì)設(shè)計(jì)說明書；（5）用戶操作手冊；（6）測試計(jì)劃；（7）測試分析報(bào)告所引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。）
二．測試計(jì)劃執(zhí)行情況
1．測試項(xiàng)目（列出每一測試項(xiàng)目的名稱、內(nèi)容和目的。）
2．測試機(jī)構(gòu)和人員（給出測試機(jī)構(gòu)名稱、負(fù)責(zé)人和參與測試人員名單。）
3．測試結(jié)果（按順序給出每一測試項(xiàng)目的：（1）實(shí)測結(jié)果數(shù)據(jù)（2）與預(yù)期結(jié)果數(shù)據(jù)的偏差（3）該項(xiàng)測試說明的事實(shí)（4）該項(xiàng)測試發(fā)現(xiàn)的問題。）
三．軟件需求測試結(jié)論（按順序給出每一項(xiàng)需求測試的結(jié)論。包括：（1）證實(shí)的軟件能力（2）局限性（即項(xiàng)需求未得到充分測試的情況及原因）。）
四．評價
1．軟件能力（經(jīng)過測試所表明的軟件能力。）
2．缺陷和限制（說明測試所揭露的軟件缺陷和不足,以及可能給軟件運(yùn)行帶來的影響。）
3．建議（提出為彌補(bǔ)上述缺陷的建議。）
4．測試結(jié)論（說明能否通過。）
開發(fā)進(jìn)度報(bào)告
一．報(bào)告時間及所處的開發(fā)階段
二．給出進(jìn)度
1． 本周的主要活動
2． 實(shí)際進(jìn)展與計(jì)劃比較
三．所用工時（按不同層次人員分別計(jì)時。）
四．所有機(jī)時
五．工作遇到的問題及采取的對策
六．本周完成的成果
七．下周的工作計(jì)劃
八．特殊問題
項(xiàng)目開發(fā)總結(jié)報(bào)告(包括以該報(bào)告為基礎(chǔ)編寫一篇ppt文檔，以供項(xiàng)目結(jié)束時參加項(xiàng)目答辯)
一．引言
1．編寫目的（闡明編寫總結(jié)報(bào)告的目的,指明讀者對象。）
2．項(xiàng)目背景（說明項(xiàng)目的來源、委托單位、開發(fā)單位及主管部門。）
3．定義（列出報(bào)告中用到的專門術(shù)語定義和縮寫詞的原意。）
4．參
考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；
（4）詳細(xì)設(shè)計(jì)說明書；（5）用戶操作手冊；（6）測試計(jì)劃；（7）測試分析報(bào)告（8）本報(bào)告引用的其他資料、采用的開發(fā)標(biāo)準(zhǔn)或開發(fā)規(guī)范。）
二．開發(fā)結(jié)果
1． 產(chǎn)品（可包括：（1）列出各部分的程序名稱、源程序行數(shù)（包括注釋行）或目標(biāo)程序字節(jié)數(shù)及程序總計(jì)數(shù)量、存儲形式；產(chǎn)品文檔名稱等。）
2． 主要功能及性能
3． 所用工時（按人員的不同層次分別計(jì)時。）
4． 所用機(jī)時
5． 進(jìn)度（給出計(jì)劃進(jìn)度與實(shí)際進(jìn)度的對比。）
三．評價
1．生產(chǎn)率評價（如平均每人每周源程序行數(shù)、文檔的字?jǐn)?shù)等。）
2．技術(shù)方案評價
3．產(chǎn)品質(zhì)量評價
四．經(jīng)驗(yàn)與教訓(xùn)
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
