◇ 可行性分析報告:說(shuō)明該軟件開(kāi)發(fā)項目的實(shí)現在技術(shù)上、經(jīng)濟上和社會(huì )因素上的可行性,評述為了合理地達到開(kāi)發(fā)目標可供選擇的各種可能實(shí)施方案,說(shuō)明并論證所選定實(shí)施方案的理由。
◇ 項目開(kāi)發(fā)計劃:為軟件項目實(shí)施方案制訂出具體計劃,應該包括各部分工作的負責人員、開(kāi)發(fā)的進(jìn)度、開(kāi)發(fā)經(jīng)費的預算、所需的硬件及軟件資源等。
◇ 軟件需求說(shuō)明書(shū)(軟件規格說(shuō)明書(shū)):對所開(kāi)發(fā)軟件的功能、性能、用戶(hù)界面及運行環(huán)境等作出詳細的說(shuō)明。它是在用戶(hù)與開(kāi)發(fā)人員雙方對軟件需求取得共同理解并達成協(xié)議的條件下編寫(xiě)的,也是實(shí)施開(kāi)發(fā)工作的基礎。該說(shuō)明書(shū)應給出數據邏輯和數據采集的各項要求,為生成和維護系統數據文件做好準備。
◇ 概要設計說(shuō)明書(shū):該說(shuō)明書(shū)是概要實(shí)際階段的工作成果,它應說(shuō)明功能分配、模塊劃分、程序的總體結構、輸入輸出以及接口設計、運行設計、數據結構設計和出錯處理設計等,為詳細設計提供基礎。
◇ 詳細設計說(shuō)明書(shū):著(zhù)重描述每一模塊是怎樣實(shí)現的,包括實(shí)現算法、邏輯流程等。
◇ 用戶(hù)操作手冊:本手冊詳細描述軟件的功能、性能和用戶(hù)界面,使用戶(hù)對如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運行情況的有關(guān)知識,特別是操作方法的具體細節。
◇ 測試計劃:為做好集成測試和驗收測試,需為如何組織測試制訂實(shí)施計劃。計劃應包括測試的內容、進(jìn)度、條件、人員、測試用例的選取原則、測試結果允許的偏差范圍等。
◇ 測試分析報告:測試工作完成以后,應提交測試計劃執行情況的說(shuō)明,對測試結果加以分析,并提出測試的結論意見(jiàn)。
◇ 開(kāi)發(fā)進(jìn)度月報:該月報系軟件人員按月向管理部門(mén)提交的項目進(jìn)展情況報告,報告應包括進(jìn)度計劃與實(shí)際執行情況的比較、階段成果、遇到的問(wèn)題和解決的辦法以及下個(gè)月的打算等。
◇ 項目開(kāi)發(fā)總結報告:軟件項目開(kāi)發(fā)完成以后,應與項目實(shí)施計劃對照,總結實(shí)際執行的情況,如進(jìn)度、成果、資源利用、成本和投入的人力,此外,還需對開(kāi)發(fā)工作做出評價(jià),總結出經(jīng)驗和教訓。
◇ 軟件維護手冊:主要包括軟件系統說(shuō)明、程序模塊說(shuō)明、操作環(huán)境、支持軟件的說(shuō)明、維護過(guò)程的說(shuō)明,便于軟件的維護。
◇ 軟件問(wèn)題報告:指出軟件問(wèn)題的登記情況,如日期、發(fā)現人、狀態(tài)、問(wèn)題所屬模塊等,為軟件修改提供準備文檔。
◇ 軟件修改報告:軟件產(chǎn)品投入運行以后,發(fā)現了需對其進(jìn)行修正、更改等問(wèn)題,應將存在的問(wèn)題、修改的考慮以及修改的影響作出詳細的描述,提交審批。
可行性分析報告
1 引言
1.1 編寫(xiě)目的:闡明編寫(xiě)可行性研究報告的目的,提出讀者對象。
1.2 項目背景:應包括
● 所建議開(kāi)發(fā)軟件的名稱(chēng)
● 項目的任務(wù)提出者、開(kāi)發(fā)者、用戶(hù)及實(shí)現軟件的單位
● 項目與其他軟件或其他系統的關(guān)系。
1.3 定義:列出文檔中用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的原文。
1.4 參考資料:列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源,可包括
● 項目經(jīng)核準的計劃任務(wù)書(shū)、合同或上級機關(guān)的批文
● 與項目有關(guān)的已發(fā)表的資料
● 文檔中所引用的資料,所采用的軟件標準或規范
2 可行性研究的前提
2.1 要求:列出并說(shuō)明建議開(kāi)發(fā)軟件的的基本要求,如
● 功能
● 性能
● 輸入/輸出
● 基本的數據流程和處理流程
● 安全與保密要求
● 與軟件相關(guān)的其他系統
● 完成日期
2.2 目標:可包括
● 人力與設備費用的節省
● 處理速度的提高
● 控制精度或生產(chǎn)力的提高
● 管理信息服務(wù)的改進(jìn)
● 決策系統的改進(jìn)
● 人員工作效率的提高
2.3 條件、假定和限制:可包括
● 建議開(kāi)發(fā)軟件運行的最短壽命
● 進(jìn)行顯然方案選擇比較的期限
● 經(jīng)費來(lái)源和使用限制
● 法律和政策方面的限制
● 硬件、軟件、運行環(huán)境和開(kāi)發(fā)環(huán)境的條件和限制
● 可利用的信息和資源
● 建議開(kāi)發(fā)軟件投入使用的最遲時(shí)間
2.4 可行性研究方法
2.5 決定可行性的主要因素
3 對現有系統的分析
3.1 處理流程和數據流程
3.2 工作負荷
3.3 費用支出:如人力、設備、空間、支持性服務(wù)、材料等項開(kāi)支
3.4 人員:列出所需人員的專(zhuān)業(yè)技術(shù)類(lèi)別和數量
3.5 設備
3.6 局限性:說(shuō)明現有系統存在的問(wèn)題以及為什么需要開(kāi)發(fā)新的系統
4 所建議技術(shù)可行性分析
4.1 對系統的簡(jiǎn)要描述
4.2 與現有系統比較的優(yōu)越性
4.3 處理流程和數據流程
4.4 采用建議系統可能帶來(lái)的影響
● 對設備的影響
● 對現有軟件的影響
● 對用戶(hù)的影響
● 對系統運行的影響
● 對開(kāi)發(fā)環(huán)境的影響
● 對經(jīng)費支出的影響
4.5 技術(shù)可行性評價(jià):包括
● 在限制條件下,功能目的是否達到
● 利用現有技術(shù),功能目的是否達到
● 對開(kāi)發(fā)人員數量和質(zhì)量的要求,并說(shuō)明能否滿(mǎn)足
● 在規定的期限內,開(kāi)發(fā)能否完成
5 所建議系統經(jīng)濟可行性分析
5.1 支出
5.2 效益
5.3 收益/投資比
5.4 投資回收周期
5.5 敏感性分析:指一些關(guān)鍵性因素,如:
● 系統生存周期長(cháng)短
● 系統工作負荷量
● 處理速度要求
● 設備和軟件配置變化對支出和效益的影響等的分析
6 社會(huì )因素可行性分析
6.1 法律因素:如
● 合同責任
● 侵犯專(zhuān)利權
● 侵犯版權
6.2 用戶(hù)使用可行性:如
● 用戶(hù)單位的行政管理
● 工作制度
● 人員素質(zhì)等能否滿(mǎn)足要求
7 其他可供選擇的方案
逐個(gè)闡明其它可供選擇的方案,并重點(diǎn)說(shuō)明未被推薦的理由。
8 結論意見(jiàn)
● 可著(zhù)手組織開(kāi)發(fā)
● 需等待若干條件具備后才能開(kāi)發(fā)
● 需對開(kāi)發(fā)目標進(jìn)行某些修改
● 不能進(jìn)行或不必進(jìn)行
● 其它
項目開(kāi)發(fā)計劃
1 引言
1.1 編寫(xiě)目的:闡明編寫(xiě)可行性研究報告的目的,提出讀者對象
1.2 項目背景:應包括
● 項目的委托單位、開(kāi)發(fā)單位和主管部門(mén);
● 該軟件系統與其他系統的關(guān)系。
1.3 定義:列出文檔中用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的原文
1.4 參考資料:可包括:
● 項目經(jīng)核準的計劃任務(wù)書(shū)、合同或上級機關(guān)的批文
● 文檔所引用的資料、規范等
● 列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源;
2 項目概述
2.1 工作內容:簡(jiǎn)要說(shuō)明項目的各項主要工作,介紹所開(kāi)發(fā)軟件的功能、性能等;若不編寫(xiě)可行性研究報告;則應在本節給出較詳細的介紹;
2.2 條件與限制: 闡明為完成項目應具備的條件、開(kāi)發(fā)單位已具備的條件以及尚需創(chuàng )造的條件。必要時(shí)還應說(shuō)明用戶(hù)及分合同承擔的工作、完成期限及其他條件與限制。
2.3 產(chǎn)品
2.3.1程序:列出應交付的程序名稱(chēng)、使用的語(yǔ)言及存儲形式。
2.3.2文檔:列出應交付的文檔。
2.4 運行環(huán)境:應包括硬件環(huán)境、軟件環(huán)境。
2.5 服務(wù):闡明開(kāi)發(fā)單位可向用戶(hù)提供的服務(wù)。如人員培訓、安裝、保修、維護和其他運行支持。
2.6 驗收標準
3 實(shí)施計劃
3.1 任務(wù)分解:任務(wù)的劃分及各項任務(wù)的負責人。
3.2 進(jìn)度:按階段完成的項目,用圖表說(shuō)明開(kāi)始時(shí)間、完成時(shí)間。
3.3 預算
3.4 關(guān)鍵問(wèn)題:說(shuō)明可能影響項目的關(guān)鍵問(wèn)題,如設備條件、技術(shù)難點(diǎn)或其他風(fēng)險因素,并說(shuō)明對策。
4 人員組織及分工
5 交付期限
6 專(zhuān)題計劃要點(diǎn)
如測試計劃、質(zhì)量保證計劃、配置管理計劃、人員培訓計劃、系統安裝計劃等。
軟件需求說(shuō)明書(shū)
1 引言
1.1 編寫(xiě)目的:闡明編寫(xiě)需求說(shuō)明書(shū)的目的,指明讀者對象。
1.2 項目背景:應包括
● 項目的委托單位、開(kāi)心單位和主管部門(mén);
● 該軟件系統與其他系統的關(guān)系。
1.3 定義:列出文檔中所用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的愿文。
1.4 參考資料:可包括
● 項目經(jīng)核準的計劃任務(wù)書(shū)、合同或上級機關(guān)的批文
● 文檔所引用的資料、規范等
● 列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源
2 任務(wù)概述
2.1 目標
2.2 運行環(huán)境
2.3 條件與限制
3 數據描述
3.1 表態(tài)數據
3.2 動(dòng)態(tài)數據:包括輸入數據和輸出數據。
3.3 數據庫描述:給出使用數據庫的名稱(chēng)和類(lèi)型。
3.4 數據詞典
3.5 數據采集
4 功能需求
4.1功能劃分
4.2功能描述
5 性能需求
5.1 數據精確度
5.2 時(shí)間特性:如響應時(shí)間、更新處理時(shí)間、數據轉換與傳輸時(shí)間、運行時(shí)間等。
5.3 適應性:在操作方式、運行環(huán)境、與其他軟件的接口以及開(kāi)發(fā)計劃等發(fā)生變化時(shí),應具有的適應能力。
6 運行需求
6.1 用戶(hù)界面:如屏幕格式、報表格式、菜單格式、輸入輸出時(shí)間等。
6.2 硬件接口
6.3 軟件接口
6.4 故障處理
7 其他需求
如可使用性、安全保密、可維護性、可移植性等。
概要設計說(shuō)明書(shū)
1 引言
1.1 寫(xiě)目的:闡明編寫(xiě)概要設計說(shuō)明書(shū)的目的,指明讀者對象。
1.2 項目背景:應包括
● 項目的委托單位、開(kāi)發(fā)單位和主管部門(mén)
● 該軟件系統與其他系統的關(guān)系。
1.3 定義:列出本文檔中所用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的愿意。
1.4 參考資料:
● 列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源
●項目經(jīng)核準的計劃任務(wù)書(shū)、合同或上級機關(guān)的批文;項目開(kāi)發(fā)計劃;需求規格說(shuō)明書(shū);測試計劃(初稿);用戶(hù)操作手冊
● 文檔所引用的資料、采用的標準或規范。
2 任務(wù)概述
2.1 目標
2.2 需求概述
2.3 條件與限制
3 總體設計
3.2 總體結構和模塊外部設計
3.3 功能分配:表明各項功能與程序結構的關(guān)系。
4 接口設計
4.1 外部接口:包括用戶(hù)界面、軟件接口與硬件接口。
4.2 內部接口:模塊之間的接口。
5 數據結構設計
6 邏輯結構設計
所有文檔的統一封面格式如下頁(yè)所示。
8 數據結構與程序的關(guān)系
9 運行設計
9.1 運行模塊的組合
9.2 運行控制
9.3 運行時(shí)間
10 出錯處理設計
10.1 出錯輸出信息
10.2 出錯處理對策:如設置后備、性能降級、恢復及再啟動(dòng)等。
11 安全保密設計
12 維護設計
說(shuō)明為方便維護工作的設施,如維護模塊等。
詳細設計說(shuō)明書(shū)
1 引言
1.1 編寫(xiě)目的:闡明編寫(xiě)詳細設計說(shuō)明書(shū)的目的,指明讀者對象。
1.2 項目背景:應包括項目的來(lái)源和主管部門(mén)等。
1.3 定義:列出本文檔中所用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的愿意。
1.4 參考資料:
● 列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源
●項目經(jīng)核準的計劃任務(wù)書(shū)、合同或上級機關(guān)的批文;項目開(kāi)發(fā)計劃;需求規格說(shuō)明書(shū);概要設計說(shuō)明書(shū);測試計劃(初稿);用戶(hù)操作手冊
● 文檔所引用的資料、軟件開(kāi)發(fā)的標準或規范。
2 總體設計
2.1 需求概述
2.2 軟件結構:如給出軟件系統的結構圖。
3 程序描述
3.1 逐個(gè)模塊給出以下說(shuō)明:
● 功能
● 性能
● 輸入項目
● 輸出項目
3.2 算法:模塊所選用的算法。
3.3 程序邏輯:詳細描述模塊實(shí)現的算法,可采用:標準流程圖;PDL語(yǔ)言;N-S圖;判定表等描述算法的圖表。
3.4 接口
● 存儲分配
● 限制條件
3.5測試要點(diǎn):給出測試模塊的主要測試要求。
用戶(hù)操作手冊
1 引言
1.1 編寫(xiě)目的:闡明編寫(xiě)手冊的目的,指明讀者對象。
1.2 項目背景:說(shuō)明項目的來(lái)源、委托單位、開(kāi)發(fā)單位及和主管部門(mén)。
1.3 定義:列出手冊中使用的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的愿意。
1.4 參考資料:
● 列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源
● 項目經(jīng)核準的計劃任務(wù)書(shū)、合同或上級機關(guān)的批文;項目開(kāi)發(fā)計劃;需求規格說(shuō)明書(shū);概要設計說(shuō)明書(shū);詳細設計說(shuō)明書(shū);測試計劃
● 文檔中所引用的其他資料、采用的軟件工程標準或軟件工程規范。
2 軟件概述
2.1 目標
2.2 功能
2.3 性能
2.4 數據精確度:包括輸入、輸出及處理數據的精度。
2.5 時(shí)間特性:如響應時(shí)間、處理時(shí)間、數據傳輸時(shí)間等。
2.6 靈活性:在操作方式、運行環(huán)境需做某些變更時(shí)軟件的適應能力。
3 運行環(huán)境
3.1 硬件
● 列出軟件系統運行時(shí)所需的硬件最小配置,如計算機型號、主存容量
● 外存儲器、媒體、記錄格式、設備型號及數量
● 輸入、輸出設備
● 數據傳輸設備及數據轉換設備的型號及數量。
3.2 支持軟件
● 操作系統名稱(chēng)及版本號
● 語(yǔ)言編譯系統或匯編系統的名稱(chēng)及版本號
● 數據庫管理系統的名稱(chēng)及版本號
● 其他必要的支持軟件
4 使用說(shuō)明
4.1 安裝和初始化:給出程序的存儲形式、操作命令、反饋信息及其做含意、表明安裝完成的測試實(shí)例以及安裝所需的軟件工具等。
4.2 輸入:給出輸入數據或參數的要求。
● 數據背景:說(shuō)明數據來(lái)源、存儲媒體、出現頻度、限制和質(zhì)量管理等。
● 數據格式:如長(cháng)度、格式基準、標號、順序、分隔符、詞匯表、省略和重復、控制。
● 輸入舉例。
4.3 輸出:給出每項輸出數據的說(shuō)明。
● 數據背景:說(shuō)明輸出數據的去向、使用頻度、存放媒體及質(zhì)量管理等。
● 數據格式:詳細闡明每一輸出數據的格式,如首部、主體和尾部的具體形式。
● 舉例
4.4 出錯和恢復:給出出錯信息及其含意;用戶(hù)應采取的措施,如修改、恢復、再啟動(dòng)。
4.5 求助查詢(xún):說(shuō)明如何操作。
5 運行說(shuō)明
5.1 運行表:列出每種可能的運行情況,說(shuō)明其運行目的。
5.2 運行步驟:按順序說(shuō)明每和運行的步驟,應包括:
5.3 運行控制
5.4 操作信息:運行目的、運行目的、操作要求、啟動(dòng)方法、預計運行時(shí)間、操作命令格式及說(shuō)明、其他事項;
5.5輸入/輸出文件:給出建立或更新文件的有關(guān)信息,如:文件的名稱(chēng)及編號;記錄媒體;存留的目錄;文件的支配:說(shuō)明確定保留文件或廢棄文件的準則,分發(fā)文件的對象,戰勝硬件的優(yōu)先級及保密控制等。
5.6 啟動(dòng)或恢復過(guò)程
6 非常規過(guò)程
提供應急戒非常規操作的必要信息及操作步驟,如出錯處理操作、向后備系統切換操作及維護人員須知的操作和注意事項。
7 操作命令一覽表
按字母順序逐個(gè)列出全部操作命令的格式、功能及參數說(shuō)明。
8 程序文件(或命令文件)和數據文件一覽表
按文件名字母順序或按功能與模塊分類(lèi)順序逐個(gè)列出文件名稱(chēng)、標識符及說(shuō)明。
9 用戶(hù)操作舉例
測試計劃
1 引言
1.1 編寫(xiě)目的:闡明編寫(xiě)測試計劃的目的并指明讀者對象。
1.2 項目背景:說(shuō)明項目的來(lái)源、委托單位及主管部門(mén)。
1.3 定義:列出測試 計劃中所用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的原意。
1.4參考資料:列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源,可包括:項目的計劃任務(wù)書(shū)、合同或批文;項目開(kāi)發(fā)計劃;需求規格說(shuō)明書(shū);概要設計說(shuō)明書(shū);詳細設計說(shuō)明書(shū);用戶(hù)操作手冊;本測試計劃中引用的其他資料、采用
的軟件開(kāi)發(fā)標準或規范。
2 任務(wù)概述
2.1 目標
2.2 運行環(huán)境
2.3 需求概述
2.4 條件與限制
3 計劃
3.1 測試方案:說(shuō)明測試方法和選取測試用例的原則。
3.2 測試項目:列出組裝測試和確認測試中每一項測試的內容、名稱(chēng)、目的和進(jìn)度。
3.3 測試準備
3.4 測試機構及人員:測試機構名稱(chēng)、負責人和職責。
4 測試項目說(shuō)明
4.1 按順序逐個(gè)對測試項目做出說(shuō)明
4.1.1 測試項目名稱(chēng)及測試內容
4.1.2 測試用例
4.1.3 輸入:輸入的數據和輸入命令。
4.1.4 輸出:預期的輸出數據。
4.2 步驟及操作
4.3 允許偏差:給出實(shí)測結果與預期結果之間允許偏差的范圍。
4.4 進(jìn)度
4.5 條件:給出項測試對資源的特殊要求,如設備、軟件、人員等。
4.6 測試資料:說(shuō)明項測試所需的資料。
5 評價(jià)
5.1 范圍:說(shuō)明所完成的各項測試說(shuō)明問(wèn)題的范圍及其局限性。
5.2 準則:說(shuō)明評論測試結果的準則。
測試分析報告
1 引言
1.1 編寫(xiě)目的:闡明編寫(xiě)測試分析報告的目的并指明讀者對象。
1.2 項目背景:說(shuō)明項目的來(lái)源、委托單位及主管部門(mén)。
1.3定義:列出測試分析報告中所用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的原意。
1.4參考資料:列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源,可包括:項目的計劃任務(wù)書(shū)、合同或批文;項目開(kāi)發(fā)計劃;需求規格說(shuō)明書(shū);概要設計說(shuō)明書(shū);詳細設計說(shuō)明書(shū);用戶(hù)操作手冊;測試計劃;測試分析報告所引用的其他資料、采用的軟件工程標準或工程規范。
2 測試計劃招待情況
2.1 機構和人員:給出測試機構名稱(chēng)、負責人和參與測試人員名單。
2.2 測試結果:按順序給出每一測試項目的:實(shí)測結果數據;與預期結果數據的偏差;該項測試表明的事實(shí);該項測試發(fā)現的問(wèn)題。
3 軟件需求測試結論
按順序給出每一項需求測試的結論。包括:證實(shí)的軟件能力;局限性(即項需求未得到充分測試的情況及原因。
4 評價(jià)
4.1 軟件能力:經(jīng)過(guò)測試所表明的軟件能力。
4.2 缺陷和限制:說(shuō)明測試所揭露的軟件缺陷和不足,以及可能給軟件運行帶來(lái)的影響。
4.3 建議:提出為彌補上述缺陷的建議。
4.4 測試結論:說(shuō)明能否通過(guò)。
開(kāi)發(fā)進(jìn)度月報
1 報告時(shí)間及所處的開(kāi)發(fā)階段
2 工程進(jìn)度
2.1 本月內的主要活動(dòng)
2.2 實(shí)際進(jìn)展與計劃比較
3 所用工時(shí)
按不同層次人員分別計時(shí)。
4 所用機時(shí)
按所用計算機機型分別計時(shí)。
5 經(jīng)費支出
分類(lèi)列出本月經(jīng)費支出項目,給出支出總額,并與計劃比較。
6 工作遇到的問(wèn)題及采取的對策
7 本月完成的成果
8 下月的工作計劃
9 特殊問(wèn)題
項目開(kāi)發(fā)總結報告
1 引言
1.1 編寫(xiě)目的:闡明編寫(xiě)總結報告的目的并指明讀者對象。
1.2 項目背景:說(shuō)明項目的來(lái)源、委托單位、開(kāi)發(fā)單位及主管部門(mén)。
1.3 定義:列出報告中所用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的原意。
1.4參考資料:列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源,可包括:項目的計劃任務(wù)書(shū)、合同或批文;項目開(kāi)發(fā)計劃;需求規格說(shuō)明書(shū);概要設計說(shuō)明書(shū);詳細設計說(shuō)明書(shū);用戶(hù)操作手冊;測試計劃;測試分析報告;本報告引用的其他資料、采用的開(kāi)發(fā)標準或開(kāi)發(fā)規范。
2 開(kāi)發(fā)結果
2.1 產(chǎn)品:可包括列出各部分的程序名稱(chēng)、源程序行數(包括注釋行)或目標程序字節數及程序總計數量、存儲形式;產(chǎn)品文檔名稱(chēng)等。
2.2 主要功能及性能
2.3 所用工時(shí):按人員的不同層次分別計時(shí)。
2.4 所用機時(shí):按所用計算機機型分別計時(shí)。
2.5 進(jìn)度:給出計劃進(jìn)度與實(shí)際進(jìn)度的對比。
2.6 費用
3 評價(jià)
3.1 生產(chǎn)率評價(jià):如平均每人每月生產(chǎn)的源程序行數、文檔的字數等。
3.2 技術(shù)方案評價(jià)
3.3 產(chǎn)品質(zhì)量評價(jià)
4 經(jīng)驗與教訓
軟件維護手冊
1 引言
1.1 編寫(xiě)目的:闡明編寫(xiě)手冊的目的并指明讀者對象。
1.2 項目背景:說(shuō)明項目的提出者、開(kāi)發(fā)者、用戶(hù)和使用場(chǎng)所。
1.3 定義:列出報告中所用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的原意。
1.4 參考資料:列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來(lái)源,及保密級別,可包括:用戶(hù)操作手冊;與本項目有關(guān)的其他文檔。
2 系統說(shuō)明
2.1 系統用途:說(shuō)明系統具備的功能,輸入和輸出。
2.2 安全保密:說(shuō)明系統安全保密方面的考慮。
2.3 總體說(shuō)明:說(shuō)明系統的總體功能,對系統、子系統和作業(yè)做出綜合性的介紹,并用圖表的方式給出系統主要部分的內部關(guān)系。
2.4 程序說(shuō)明:說(shuō)明系統中每一程序、分程序的細節和特性。
2.4.1 程序1的說(shuō)明
● 功能:說(shuō)明程序的功能。
● 方法:說(shuō)明實(shí)現方法。
● 輸入:說(shuō)明程序的輸入、媒體、運行數據記錄、運行開(kāi)始時(shí)使用的輸入數據的類(lèi)型和存放單元、與程序初始化有關(guān)的入口要求。
● 處理:處理特點(diǎn)和目的,如:用圖表說(shuō)明程序的運行的邏輯流程;程序主要轉移條件;對程序的約束條件;程序結束時(shí)的出口要求;與下一個(gè)程序的通信與聯(lián)結(運行、控制);由該程序產(chǎn)生并茶館處理程序段使用的輸出數據類(lèi)型和存放單元;程序運行存儲量、類(lèi)型及存儲位置等。
● 輸出:程序的輸出。
● 接口:本程序與本系統其他部分的接口。
●表格:說(shuō)明程序內部的各種表、項的細節和特性。對每張表的說(shuō)明至少包括:表的標識符;使用目的;使用此表的其他程序;邏輯劃分,如塊或部,不包括表項;表的基本結構;設計安排,包括表的控制信息。表目結構細節、使用中的特有性質(zhì)及各表項的標識、位置、用途、類(lèi)型、編碼表示。
● 特有的運行性質(zhì):說(shuō)明在用戶(hù)操作手冊中沒(méi)有提到的運行性質(zhì)。
2.4.2程序2的說(shuō)明
與程序1的說(shuō)明相同。以后的其他各程序的說(shuō)明相同。
3 操作環(huán)境
3.1 設備:逐項說(shuō)明系統的設備配置及其特性。
3.2 支持軟件:列出系統使用的支持軟件,包括它們的名稱(chēng)和版本號。
3.3 數據庫:說(shuō)明每個(gè)數據庫的性質(zhì)和內容,包括安全考慮。
3.3.1總體特征:如標識符、使用這些數據庫的程序、靜態(tài)數據、動(dòng)態(tài)數據;數據庫的存儲媒體;程序使用數據庫的限制。
3.3.2結構及詳細說(shuō)明
● 說(shuō)明該數據庫的結構,包括其中的記錄和項。
● 說(shuō)明記錄的組成,包括首部或控制段、記錄體。
● 說(shuō)明每個(gè)記錄結構的字段,包括:標記或標號、字段的字符長(cháng)度和位數、該字段的允許值范圍。
● 擴充:說(shuō)明為記錄追加字段的規定。
4 維護過(guò)程
4.1 約定:列出該軟件系統設計中所使用全部規則和約定,包括:程序、分程序、記錄、字段和存儲區的標識或標號助記符的使用規則;圖表的處理標準、卡片的連接順序、語(yǔ)句和記號中使用的縮寫(xiě)、出現在圖表中的符號名;使用的軟件技術(shù)標準;標準化的數據元素及其特征。
4.2 驗證過(guò)程:說(shuō)明一個(gè)程序段修改后,對其進(jìn)行驗證的要求和過(guò)程(包括測試程序和數據)及程序周期性驗證的過(guò)程。
4.3 出錯及糾正方法:列出出錯狀態(tài)及其糾正方法。
4.4 專(zhuān)門(mén)維護過(guò)程:說(shuō)明文檔其他地方?jīng)]有提到的專(zhuān)門(mén)維護過(guò)程。如:維護該軟件系統的輸入輸出部分(如數據庫)的要求、過(guò)程和驗證方法;運行程序庫維護系統所必需的要求、過(guò)程和驗證方法;對閏年、世紀變更的所需要的臨時(shí)性修改等。
4.5 專(zhuān)用維護程序:列出維護軟件系統使用的后備技術(shù)和專(zhuān)用程序(如文件恢復程序、淘汰過(guò)時(shí)文件的程序等)的目錄,并加以說(shuō)明,內容包括:維護作業(yè)的輸入輸出要求;輸入的詳細過(guò)程及在硬設備上建立、運行并完成維護作業(yè)的操作步驟。
4.6 程序清單和流程圖:引用或提供附錄給出程序清單和流程圖。
軟件問(wèn)題報告
1 登記號
由軟件配置管理部門(mén)為該報告規定一個(gè)唯一的、順序的編號。
2 登記日期
軟件配置管理部門(mén)登記該報告的日期。
3 問(wèn)題發(fā)現日期
發(fā)現該問(wèn)題的日期和時(shí)間。
4 活動(dòng)
在哪個(gè)階段發(fā)現的問(wèn)題,分為單元測試、組裝測試、確認測試和運行維護。
5 狀態(tài)
在軟件配置記錄中維護的動(dòng)態(tài)指示,狀態(tài)表示有:正在復查"軟件問(wèn)題報告",以確定將采取什么行動(dòng);"軟件問(wèn)題報告"已由指定的人去進(jìn)行處理;修改已完成,并經(jīng)過(guò)測試,正準備交給主程序庫;主程序庫已經(jīng)更新,主程序庫修改的重新測試沿未完成;做了重新測試,問(wèn)題再現;做了重新測試,所做的修改無(wú)故障,"軟件問(wèn)題報告"被關(guān)閉;留待以后關(guān)閉。
6 報告人
填寫(xiě)"軟件問(wèn)題報告"人員的姓名、地址、電話(huà)。
7 問(wèn)題屬于什么方面
區分是程序的問(wèn)題,還是模塊的問(wèn)題,或是數據庫的問(wèn)題,文件的問(wèn)題。也可能是它們的某種組合。
8 模塊/子系統
出現的模塊名。如果不知是哪個(gè)模塊,可標出子系統名,盡量給出細節。
9 修訂版本號
出現問(wèn)題的模塊版本。
10 磁帶
包含有問(wèn)題的模塊的主程序庫的磁帶的標識符。
11 數據庫
當發(fā)現問(wèn)題時(shí)所使用數據庫的標識符。
12 文件號
有錯誤的文件的編號。
13 測試用例
發(fā)現錯誤時(shí)所使用測試用例的標識符。
14 硬件
發(fā)現錯誤時(shí)所使用的計算機系統的標識。
15 問(wèn)題描述/影響
問(wèn)題癥兆的詳細描述。如果可能,則寫(xiě)明實(shí)際問(wèn)題所在。也要給出該問(wèn)題對將來(lái)測試、接口軟件和文件等的影響。
16 附注
記載補充信息。
軟件修改報告
1 登記號
由軟件配置管理部門(mén)為該報告規定的編號。
2 登記日期
軟件配置管理部門(mén)登記"軟件修改報告"的日期。
3 時(shí)間
準備好"軟件修改報告"的日期。
4 報告人
填寫(xiě)該報告的作者。
5 子系統名
受修改影響的子系統名。
6 模塊名
被修改的模塊名。
7 "軟件問(wèn)題報告"的編號
被"軟件修改報告"處理或部分處理的"軟件問(wèn)題報告"的編號。如果某"軟件問(wèn)題報告"的問(wèn)題只是部分被處理,則在編號后附以p,如1234p。
8 修改
包括程序修改、文件更新、數據庫修改或它們的組合。
9 修改描述
修改的詳細描述。如果是文件更新或數據庫修改,還要列出文件更新通知或數據庫修改申請的標識符。
10 批準人
批準人簽字,正式批準進(jìn)行修改。
11 語(yǔ)句類(lèi)型
程序修改中涉及到的語(yǔ)句類(lèi)型,包括:輸入/輸出語(yǔ)句類(lèi)、計算語(yǔ)句類(lèi)、邏輯控制語(yǔ)句類(lèi)、數據處理語(yǔ)句類(lèi)(如數據傳送、存取語(yǔ)句類(lèi))。
12 程序名
被修改的程序、文件或數據庫的名字。
13 老修訂版
當前的版本/修訂本標識。
14 新修訂版
修改后的版本/修訂本標識。
15 數據庫
如果申請數據庫修改,則給出數據庫的標識符。
16 數據庫修改報告
數據庫修改申請號。
17 文件
如果要求對文件進(jìn)行修改,則給出文件的名字。
18 文件更新
文件更新通知單的編號。
19 修改是否已測試
指出已對修改做了哪些測試,如單元、子系統、組裝、確認和運行測試等,并注明測試成功與否。
20 "軟件問(wèn)題報告"是否給出問(wèn)題的準確描述
回答‘是‘或‘否‘。
21 問(wèn)題注釋
準確地敘述要維護的問(wèn)題。
22 問(wèn)題源
指明問(wèn)題來(lái)自于哪里,如軟件需求說(shuō)明書(shū)、設計說(shuō)明書(shū)、數據庫、源程序等。
23 資源
完成修改所需資源的估計,即總的人時(shí)數和計算機時(shí)間的開(kāi)銷(xiāo)。
聯(lián)系客服