文檔分類 項目包括如下幾類文檔; 專案管理文檔。包括:《軟體專案計劃》、《項目進度報告》、《項目開發總結報告》 軟體開發文檔。包括:《需求規格說明》、《概要設計說明》、《詳細設計說明》。 軟體測試文檔。包括:《測試計劃》、《軟體測試分析報告》。 產品資料。包括:《使用者操作手冊》。
文檔的版本號碼 本項目文檔的版本號碼由以圓點隔開的兩個數字組成,第一個數字表示出版號,第二個數字表示該版的修訂編號。具體用法如下: 當文檔初版時,版本號碼為 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 Pl