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