1. 程式人生 > >軟件開發十三種文檔格式

軟件開發十三種文檔格式

知識 ont 測試方法 標識符 細節 介紹 信息服務 發的 不同

在項目開發過程中,應該按要求編寫好十三種文檔,文檔編制要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性。

  ◇ 可行性分析報告:說明該軟件開發項目的實現在技術上、經濟上和社會因素上的可行性,評述為了合理地達到開發目標可供選擇的各種可能實施方案,說明並論證所選定實施方案的理由。
◇ 項目開發計劃:為軟件項目實施方案制訂出具體計劃,應該包括各部分工作的負責人員、開發的進度、開發經費的預算、所需的硬件及軟件資源等。
◇ 軟件需求說明書(軟件規格說明書):對所開發軟件的功能、性能、用戶界面及運行環境等作出詳細的說明。它是在用戶與開發人員雙方對軟件需求取得共同理解並 達成協議的條件下編寫的,也是實施開發工作的基礎。該說明書應給出數據邏輯和數據采集的各項要求,為生成和維護系統數據文件做好準備。


◇ 概要設計說明書:該說明書是概要實際階段的工作成果,它應說明功能分配、模塊劃分、程序的總體結構、輸入輸出以及接口設計、運行設計、數據結構設計和出錯處理設計等,為詳細設計提供基礎。
◇ 詳細設計說明書:著重描述每一模塊是怎樣實現的,包括實現算法、邏輯流程等。
◇ 用戶操作手冊:本手冊詳細描述軟件的功能、性能和用戶界面,使用戶對如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運行情況的有關知識,特別是操作方法的具體細節。
◇ 測試計劃:為做好集成測試和驗收測試,需為如何組織測試制訂實施計劃。計劃應包括測試的內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差範圍等。
◇ 測試分析報告:測試工作完成以後,應提交測試計劃執行情況的說明,對測試結果加以分析,並提出測試的結論意見。

◇ 開發進度月報:該月報系軟件人員按月向管理部門提交的項目進展情況報告,報告應包括進度計劃與實際執行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。
◇ 項目開發總結報告:軟件項目開發完成以後,應與項目實施計劃對照,總結實際執行的情況,如進度、成果、資源利用、成本和投入的人力,此外,還需對開發工作做出評價,總結出經驗和教訓。
◇ 軟件維護手冊:主要包括軟件系統說明、程序模塊說明、操作環境、支持軟件的說明、維護過程的說明,便於軟件的維護。
◇ 軟件問題報告:指出軟件問題的登記情況,如日期、發現人、狀態、問題所屬模塊等,為軟件修改提供準備文檔。
◇ 軟件修改報告:軟件產品投入運行以後,發現了需對其進行修正、更改等問題,應將存在的問題、修改的考慮以及修改的影響作出詳細的描述,提交審批。


可行性分析報告

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


項目開發計劃

1 引言
1.1 編寫目的:闡明編寫可行性研究報告的目的,提出讀者對象
1.2 項目背景:應包括
● 項目的委托單位、開發單位和主管部門;
● 該軟件系統與其他系統的關系。
1.3 定義:列出文檔中用到的專門術語的定義和縮寫詞的原文
1.4 參考資料:可包括:
● 項目經核準的計劃任務書、合同或上級機關的批文
● 文檔所引用的資料、規範等
● 列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源;
2 項目概述
2.1 工作內容:簡要說明項目的各項主要工作,介紹所開發軟件的功能、性能等;若不編寫可行性研究報告;則應在本節給出較詳細的介紹;
2.2 條件與限制: 闡明為完成項目應具備的條件、開發單位已具備的條件以及尚需創造的條件。必要時還應說明用戶及分合同承擔的工作、完成期限及其他條件與限制。
2.3 產品
2.3.1程序:列出應交付的程序名稱、使用的語言及存儲形式。
2.3.2文檔:列出應交付的文檔。
2.4 運行環境:應包括硬件環境、軟件環境。
2.5 服務:闡明開發單位可向用戶提供的服務。如人員培訓、安裝、保修、維護和其他運行支持。
2.6 驗收標準
3 實施計劃
3.1 任務分解:任務的劃分及各項任務的負責人。
3.2 進度:按階段完成的項目,用圖表說明開始時間、完成時間。
3.3 預算
3.4 關鍵問題:說明可能影響項目的關鍵問題,如設備條件、技術難點或其他風險因素,並說明對策。
4 人員組織及分工
5 交付期限
6 專題計劃要點
如測試計劃、質量保證計劃、配置管理計劃、人員培訓計劃、系統安裝計劃等。


軟件需求說明書

1 引言
1.1 編寫目的:闡明編寫需求說明書的目的,指明讀者對象。
1.2 項目背景:應包括
● 項目的委托單位、開心單位和主管部門;
● 該軟件系統與其他系統的關系。
1.3 定義:列出文檔中所用到的專門術語的定義和縮寫詞的願文。
1.4 參考資料:可包括
● 項目經核準的計劃任務書、合同或上級機關的批文
● 文檔所引用的資料、規範等
● 列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源
2 任務概述
2.1 目標
2.2 運行環境
2.3 條件與限制
3 數據描述
3.1 表態數據
3.2 動態數據:包括輸入數據和輸出數據。
3.3 數據庫描述:給出使用數據庫的名稱和類型。
3.4 數據詞典
3.5 數據采集
4 功能需求
4.1功能劃分
4.2功能描述
5 性能需求
5.1 數據精確度
5.2 時間特性:如響應時間、更新處理時間、數據轉換與傳輸時間、運行時間等。
5.3 適應性:在操作方式、運行環境、與其他軟件的接口以及開發計劃等發生變化時,應具有的適應能力。
6 運行需求
6.1 用戶界面:如屏幕格式、報表格式、菜單格式、輸入輸出時間等。
6.2 硬件接口
6.3 軟件接口
6.4 故障處理
7 其他需求
如可使用性、安全保密、可維護性、可移植性等。


概要設計說明書

1 引言
1.1 寫目的:闡明編寫概要設計說明書的目的,指明讀者對象。
1.2 項目背景:應包括
● 項目的委托單位、開發單位和主管部門
● 該軟件系統與其他系統的關系。
1.3 定義:列出本文檔中所用到的專門術語的定義和縮寫詞的願意。
1.4 參考資料:
● 列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源
●項目經核準的計劃任務書、合同或上級機關的批文;項目開發計劃;需求規格說明書;測試計劃(初稿);用戶操作手冊
● 文檔所引用的資料、采用的標準或規範。
2 任務概述
2.1 目標
2.2 需求概述
2.3 條件與限制
3 總體設計
3.2 總體結構和模塊外部設計
3.3 功能分配:表明各項功能與程序結構的關系。
4 接口設計
4.1 外部接口:包括用戶界面、軟件接口與硬件接口。
4.2 內部接口:模塊之間的接口。
5 數據結構設計
6 邏輯結構設計
所有文檔的統一封面格式如下頁所示。
7 物理結構設計
8 數據結構與程序的關系
9 運行設計
9.1 運行模塊的組合
9.2 運行控制
9.3 運行時間
10 出錯處理設計
10.1 出錯輸出信息
10.2 出錯處理對策:如設置後備、性能降級、恢復及再啟動等。
11 安全保密設計
12 維護設計
說明為方便維護工作的設施,如維護模塊等。


詳細設計說明書

1 引言
1.1 編寫目的:闡明編寫詳細設計說明書的目的,指明讀者對象。
1.2 項目背景:應包括項目的來源和主管部門等。
1.3 定義:列出本文檔中所用到的專門術語的定義和縮寫詞的願意。
1.4 參考資料:
● 列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源
●項目經核準的計劃任務書、合同或上級機關的批文;項目開發計劃;需求規格說明書;概要設計說明書;測試計劃(初稿);用戶操作手冊
● 文檔所引用的資料、軟件開發的標準或規範。
2 總體設計
2.1 需求概述
2.2 軟件結構:如給出軟件系統的結構圖。
3 程序描述
3.1 逐個模塊給出以下說明:
● 功能
● 性能
● 輸入項目
● 輸出項目
3.2 算法:模塊所選用的算法。
3.3 程序邏輯:詳細描述模塊實現的算法,可采用:標準流程圖;PDL語言;N-S圖;判定表等描述算法的圖表。
3.4 接口
● 存儲分配
● 限制條件
3.5測試要點:給出測試模塊的主要測試要求。


用戶操作手冊

1 引言
1.1 編寫目的:闡明編寫手冊的目的,指明讀者對象。
1.2 項目背景:說明項目的來源、委托單位、開發單位及和主管部門。
1.3 定義:列出手冊中使用的專門術語的定義和縮寫詞的願意。
1.4 參考資料:
● 列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源
● 項目經核準的計劃任務書、合同或上級機關的批文;項目開發計劃;需求規格說明書;概要設計說明書;詳細設計說明書;測試計劃
● 文檔中所引用的其他資料、采用的軟件工程標準或軟件工程規範。
2 軟件概述
2.1 目標
2.2 功能
2.3 性能
2.4 數據精確度:包括輸入、輸出及處理數據的精度。
2.5 時間特性:如響應時間、處理時間、數據傳輸時間等。
2.6 靈活性:在操作方式、運行環境需做某些變更時軟件的適應能力。
3 運行環境
3.1 硬件
● 列出軟件系統運行時所需的硬件最小配置,如計算機型號、主存容量
● 外存儲器、媒體、記錄格式、設備型號及數量
● 輸入、輸出設備
● 數據傳輸設備及數據轉換設備的型號及數量。
3.2 支持軟件
● 操作系統名稱及版本號
● 語言編譯系統或匯編系統的名稱及版本號
● 數據庫管理系統的名稱及版本號
● 其他必要的支持軟件
4 使用說明
4.1 安裝和初始化:給出程序的存儲形式、操作命令、反饋信息及其做含意、表明安裝完成的測試實例以及安裝所需的軟件工具等。
4.2 輸入:給出輸入數據或參數的要求。
● 數據背景:說明數據來源、存儲媒體、出現頻度、限制和質量管理等。
● 數據格式:如長度、格式基準、標號、順序、分隔符、詞匯表、省略和重復、控制。
● 輸入舉例。
4.3 輸出:給出每項輸出數據的說明。
● 數據背景:說明輸出數據的去向、使用頻度、存放媒體及質量管理等。
● 數據格式:詳細闡明每一輸出數據的格式,如首部、主體和尾部的具體形式。
● 舉例
4.4 出錯和恢復:給出出錯信息及其含意;用戶應采取的措施,如修改、恢復、再啟動。
4.5 求助查詢:說明如何操作。
5 運行說明
5.1 運行表:列出每種可能的運行情況,說明其運行目的。
5.2 運行步驟:按順序說明每和運行的步驟,應包括:
5.3 運行控制
5.4 操作信息:運行目的、運行目的、操作要求、啟動方法、預計運行時間、操作命令格式及說明、其他事項;
5.5輸入/輸出文件:給出建立或更新文件的有關信息,如:文件的名稱及編號;記錄媒體;存留的目錄;文件的支配:說明確定保留文件或廢棄文件的準則,分發文件的對象,戰勝硬件的優先級及保密控制等。
5.6 啟動或恢復過程
6 非常規過程
提供應急戒非常規操作的必要信息及操作步驟,如出錯處理操作、向後備系統切換操作及維護人員須知的操作和註意事項。
7 操作命令一覽表
按字母順序逐個列出全部操作命令的格式、功能及參數說明。
8 程序文件(或命令文件)和數據文件一覽表
按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明。
9 用戶操作舉例


測試計劃

1 引言
1.1 編寫目的:闡明編寫測試計劃的目的並指明讀者對象。
1.2 項目背景:說明項目的來源、委托單位及主管部門。
1.3 定義:列出測試 計劃中所用到的專門術語的定義和縮寫詞的原意。
1.4參考資料:列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源,可包括:項目的計劃任務書、合同或批文;項目開發計劃;需求規格說明書;概要設計說明書;詳細設計說明書;用戶操作手冊;本測試計劃中引用的其他資料、采用
的軟件開發標準或規範。
2 任務概述
2.1 目標
2.2 運行環境
2.3 需求概述
2.4 條件與限制
3 計劃
3.1 測試方案:說明測試方法和選取測試用例的原則。
3.2 測試項目:列出組裝測試和確認測試中每一項測試的內容、名稱、目的和進度。
3.3 測試準備
3.4 測試機構及人員:測試機構名稱、負責人和職責。
4 測試項目說明
4.1 按順序逐個對測試項目做出說明
4.1.1 測試項目名稱及測試內容
4.1.2 測試用例
4.1.3 輸入:輸入的數據和輸入命令。
4.1.4 輸出:預期的輸出數據。
4.2 步驟及操作
4.3 允許偏差:給出實測結果與預期結果之間允許偏差的範圍。
4.4 進度
4.5 條件:給出項測試對資源的特殊要求,如設備、軟件、人員等。
4.6 測試資料:說明項測試所需的資料。
5 評價
5.1 範圍:說明所完成的各項測試說明問題的範圍及其局限性。
5.2 準則:說明評論測試結果的準則。


測試分析報告

1 引言
1.1 編寫目的:闡明編寫測試分析報告的目的並指明讀者對象。
1.2 項目背景:說明項目的來源、委托單位及主管部門。
1.3定義:列出測試分析報告中所用到的專門術語的定義和縮寫詞的原意。
1.4參考資料:列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源,可包括:項目的計劃任務書、合同或批文;項目開發計劃;需求規格說明 書;概要設計說明書;詳細設計說明書;用戶操作手冊;測試計劃;測試分析報告所引用的其他資料、采用的軟件工程標準或工程規範。
2 測試計劃招待情況
2.1 機構和人員:給出測試機構名稱、負責人和參與測試人員名單。
2.2 測試結果:按順序給出每一測試項目的:實測結果數據;與預期結果數據的偏差;該項測試表明的事實;該項測試發現的問題。
3 軟件需求測試結論
按順序給出每一項需求測試的結論。包括:證實的軟件能力;局限性(即項需求未得到充分測試的情況及原因。
4 評價
4.1 軟件能力:經過測試所表明的軟件能力。
4.2 缺陷和限制:說明測試所揭露的軟件缺陷和不足,以及可能給軟件運行帶來的影響。
4.3 建議:提出為彌補上述缺陷的建議。
4.4 測試結論:說明能否通過。


開發進度月報

1 報告時間及所處的開發階段
2 工程進度
2.1 本月內的主要活動
2.2 實際進展與計劃比較
3 所用工時
按不同層次人員分別計時。
4 所用機時
按所用計算機機型分別計時。
5 經費支出
分類列出本月經費支出項目,給出支出總額,並與計劃比較。
6 工作遇到的問題及采取的對策
7 本月完成的成果
8 下月的工作計劃
9 特殊問題


項目開發總結報告

1 引言
1.1 編寫目的:闡明編寫總結報告的目的並指明讀者對象。
1.2 項目背景:說明項目的來源、委托單位、開發單位及主管部門。
1.3 定義:列出報告中所用到的專門術語的定義和縮寫詞的原意。
1.4參考資料:列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源,可包括:項目的計劃任務書、合同或批文;項目開發計劃;需求規格說明 書;概要設計說明書;詳細設計說明書;用戶操作手冊;測試計劃;測試分析報告;本報告引用的其他資料、采用的開發標準或開發規範。
2 開發結果
2.1 產品:可包括列出各部分的程序名稱、源程序行數(包括註釋行)或目標程序字節數及程序總計數量、存儲形式;產品文檔名稱等。
2.2 主要功能及性能
2.3 所用工時:按人員的不同層次分別計時。
2.4 所用機時:按所用計算機機型分別計時。
2.5 進度:給出計劃進度與實際進度的對比。
2.6 費用
3 評價
3.1 生產率評價:如平均每人每月生產的源程序行數、文檔的字數等。
3.2 技術方案評價
3.3 產品質量評價
4 經驗與教訓


軟件維護手冊

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


軟件問題報告

1 登記號
由軟件配置管理部門為該報告規定一個唯一的、順序的編號。
2 登記日期
軟件配置管理部門登記該報告的日期。
3 問題發現日期
發現該問題的日期和時間。
4 活動
在哪個階段發現的問題,分為單元測試、組裝測試、確認測試和運行維護。
5 狀態
在軟件配置記錄中維護的動態指示,狀態表示有:正在復查"軟件問題報告",以確定將采取什麽行動;"軟件問題報告"已由指定的人去進行處理;修改已完 成,並經過測試,正準備交給主程序庫;主程序庫已經更新,主程序庫修改的重新測試沿未完成;做了重新測試,問題再現;做了重新測試,所做的修改無故障," 軟件問題報告"被關閉;留待以後關閉。
6 報告人
填寫"軟件問題報告"人員的姓名、地址、電話。
7 問題屬於什麽方面
區分是程序的問題,還是模塊的問題,或是數據庫的問題,文件的問題。也可能是它們的某種組合。
8 模塊/子系統
出現的模塊名。如果不知是哪個模塊,可標出子系統名,盡量給出細節。
9 修訂版本號
出現問題的模塊版本。
10 磁帶
包含有問題的模塊的主程序庫的磁帶的標識符。
11 數據庫
當發現問題時所使用數據庫的標識符。
12 文件號
有錯誤的文件的編號。
13 測試用例
發現錯誤時所使用測試用例的標識符。
14 硬件
發現錯誤時所使用的計算機系統的標識。
15 問題描述/影響
問題癥兆的詳細描述。如果可能,則寫明實際問題所在。也要給出該問題對將來測試、接口軟件和文件等的影響。
16 附註
記載補充信息。


軟件修改報告

1 登記號
由軟件配置管理部門為該報告規定的編號。
2 登記日期
軟件配置管理部門登記"軟件修改報告"的日期。
3 時間
準備好"軟件修改報告"的日期。
4 報告人
填寫該報告的作者。
5 子系統名
受修改影響的子系統名。
6 模塊名
被修改的模塊名。
7 "軟件問題報告"的編號
被"軟件修改報告"處理或部分處理的"軟件問題報告"的編號。如果某"軟件問題報告"的問題只是部分被處理,則在編號後附以p,如1234p。
8 修改
包括程序修改、文件更新、數據庫修改或它們的組合。
9 修改描述
修改的詳細描述。如果是文件更新或數據庫修改,還要列出文件更新通知或數據庫修改申請的標識符。
10 批準人
批準人簽字,正式批準進行修改。
11 語句類型
程序修改中涉及到的語句類型,包括:輸入/輸出語句類、計算語句類、邏輯控制語句類、數據處理語句類(如數據傳送、存取語句類)。
12 程序名
被修改的程序、文件或數據庫的名字。
13 老修訂版
當前的版本/修訂本標識。
14 新修訂版
修改後的版本/修訂本標識。
15 數據庫
如果申請數據庫修改,則給出數據庫的標識符。
16 數據庫修改報告
數據庫修改申請號。
17 文件
如果要求對文件進行修改,則給出文件的名字。
18 文件更新
文件更新通知單的編號。
19 修改是否已測試
指出已對修改做了哪些測試,如單元、子系統、組裝、確認和運行測試等,並註明測試成功與否。
20 "軟件問題報告"是否給出問題的準確描述
回答‘是‘或‘否‘。
21 問題註釋
準確地敘述要維護的問題。
22 問題源
指明問題來自於哪裏,如軟件需求說明書、設計說明書、數據庫、源程序等。
23 資源
完成修改所需資源的估計,即總的人時數和計算機時間的開銷。

軟件開發十三種文檔格式