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