開發(fā)總結(jié)報告、軟件問題報告、軟件修改報告、程序維護手冊模板
項目開發(fā)總結(jié)報告
項目開發(fā)總結(jié)報告
引言
1.1編寫目的
【闡明編寫總結(jié)報告的目的,指明讀者對象?!?/p>
1.2項目背景
【說明項目來源、委托單位、開發(fā)單位及主管部門。】
1.3定義
【列出報告用到的專門術(shù)語的定義和縮寫詞的原文?!?/p>
1.4參考資料
【列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源,可包括:
a. 項目經(jīng)核準的計劃任務(wù)書、合同或上級機關(guān)的批文;
b. 項目開發(fā)計劃;
c. 需求規(guī)格說明書;
d. 概要設(shè)計說明書;
e. 詳細設(shè)計說明書;
f. 用戶操作手冊;
g. 測試計劃;
h. 測試分析報告;
i. 本報告引用的其他資料、采用的開發(fā)標準或開發(fā)規(guī)范。】
2.開發(fā)結(jié)果
2.1產(chǎn)品
【可包括:
a. 列出各部分的程序名稱、源程序行數(shù)(包括注釋行)或目標程序字節(jié)數(shù)及程序總計數(shù)量、存儲形式;
b. 產(chǎn)品文檔名稱等?!?/p>
2.2主要功能及性能
2.3所用工時
【按人員的不同層次分別計時?!?/p>
2.4所用機時
【按所用計算機機型分別計時。】
2.5進度
【給出計劃進度與實際進度的對比?!?/p>
2.6費用
3.評價
3.1生產(chǎn)率評價
【如平均每人每月生產(chǎn)的源程序行數(shù)、文檔的字數(shù)等。】
3.2技術(shù)方案評價
3.3產(chǎn)品質(zhì)量評價
4.經(jīng)驗與教訓
用戶操作手冊
用戶操作手冊
引言
1.1編寫目的
【闡明編寫手冊的目的,指明讀者對象?!?/p>
1.2項目背景
【應(yīng)包括項目的來源、委托單位、開發(fā)單位和主管部門?!?/p>
1.3定義
【列出手冊中所用到的專門術(shù)語的定義和縮寫詞的原文?!?/p>
1.4參考資料
【列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源,可包括:
a. 項目的計劃任務(wù)書、合同或批文;
b. 項目開發(fā)計劃;
c. 需求規(guī)格說明書;
d. 概要設(shè)計說明書;
e. 詳細設(shè)計說明書;
f. 測試計劃;
g. 手冊中引用的其他資料、采用的軟件工程標準或軟件工程規(guī)范?!?/p>
2.軟件概述
2.1目標
2.2功能
2.3性能
a. 數(shù)據(jù)精確度【包括輸入、輸出及處理數(shù)據(jù)的精度?!?/p>
b. 時間特性【如響應(yīng)時間、處理時間、數(shù)據(jù)傳輸時間等。】
c. 靈活性【在操作方式、運行環(huán)境需做某些變更時軟件的適應(yīng)能力?!?/p>
3.運行環(huán)境
3.1硬件
【列出軟件系統(tǒng)運行時所需的硬件最小配置,如
a. 計算機型號、主存容量;
b. 外存儲器、媒體、記錄格式、設(shè)備型號及數(shù)量;
c. 輸入、輸出設(shè)備;
d. 數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號及數(shù)量。】
3.2支持軟件
【如:
a. 操作系統(tǒng)名稱及版本號;
b. 語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號;
c. 數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號;
d. 其他必要的支持軟件。】
4.使用說明
4.1安裝和初始化
【給出程序的存儲形式、操作命令、反饋信息及其含意、表明安裝完成的測試實例以及安裝所需的軟件工具等?!?/p>
4.2輸入
【給出輸入數(shù)據(jù)或參數(shù)的要求?!?/p>
4.2.1數(shù)據(jù)背景
【說明數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制和質(zhì)量管理等?!?/p>
4.2.2數(shù)據(jù)格式
【如:
a. 長度;
b. 格式基準;
c. 標號;
d. 順序;
e. 分隔符;
f. 詞匯表;
g. 省略和重復(fù);
h. 控制?!?/p>
4.2.3輸入舉例
4.3輸出
【給出每項輸出數(shù)據(jù)的說明。】
4.3.1數(shù)據(jù)背景
【說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。】
4.3.2數(shù)據(jù)格式
【詳細闡明每一輸出數(shù)據(jù)的格式,如:首部、主體和尾部的具體形式?!?/p>
4.3.3舉例
4.4出錯和恢復(fù)
【給出:
a. 出錯信息及其含意;
b. 用戶應(yīng)采取的措施,如修改、恢復(fù)、再啟動?!?/p>
4.5求助查詢
【說明如何操作?!?/p>
5.運行說明
5.1運行表
【列出每種可能的運行情況,說明其運行目的?!?/p>
5.2運行步驟
【按順序說明每種運行的步驟,應(yīng)包括:】
5.2.1運行控制
5.2.2操作信息
a. 運行目的;
b. 操作要求;
c. 啟動方法;
d. 預(yù)計運行時間;
e. 操作命令格式及說明;
f. 其他事項。
5.2.3輸入/輸出文件
【給出建立或更新文件的有關(guān)信息,如:】
a. 文件的名稱及編號;
b. 記錄媒體;
c. 存留的目錄;
d. 文件的支配【說明確定保留文件或廢棄文件的準則,分發(fā)文件的對象,占用硬件的優(yōu)先級及保密控制等?!?/p>
5.2.4啟動或恢復(fù)過程
6.非常規(guī)過程
【提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟,如出錯處理操作、向后備系統(tǒng)切換操作以及維護人員須知的操作和注意事項?!?/p>
7.操作命令一覽表
【按字母順序逐個列出全部操作命令的格式、功能及參數(shù)說明?!?/p>
8.程序文件(或命令文件)和數(shù)據(jù)文件一覽表
【按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明?!?/p>
9.用戶操作舉例
軟件問題報告
軟件問題報告
1. 登記號
【由軟件配置管理部門為該報告規(guī)定一個唯一的、順序的編號?!?/p>
2.登記日期
【軟件配置管理部門登記該報告的日期?!?/p>
3.問題發(fā)現(xiàn)日期
【發(fā)現(xiàn)該問題的日期和時間。】
4.活動
【在哪個階段發(fā)現(xiàn)的問題,分為單元測試、組裝測試、確認測試和運行維護。】
5.狀態(tài)
【在軟件配置記錄中維護的動態(tài)指示,狀態(tài)表示有:
a. 正在復(fù)查“軟件問題報告”,以確定將采取什么行動;
b. 軟件問題報告”已由指定的人去進行處理;
c. 修改已完成,并經(jīng)過測試,正準備交給主程序庫;
d. 主程序庫已經(jīng)更新,主程序庫修改的重新測試尚未完成;
e. 做了重新測試,問題再現(xiàn);
f. 做了重新測試,所做的修改已無故障,“軟件問題報告”被關(guān)閉;
g. 留待以后關(guān)閉?!?/p>
6.報告人
【填寫“軟件問題報告”人員的姓名、地址、電話?!?/p>
7.問題屬于什么方面
【區(qū)分是程序的問題,還是模塊的問題,或是數(shù)據(jù)庫的問題,文件的問題。也可能是它們的某種組合?!?/p>
8.模塊/子系統(tǒng)
【出現(xiàn)的模塊名。如果不知是哪個模塊,可標出子系統(tǒng)名,盡量給出細節(jié)?!?/p>
9.修訂版本號
【出現(xiàn)問題的模塊版本?!?/p>
10.磁帶
【包含有問題的模塊的主程序庫的磁帶的標識符?!?/p>
11.數(shù)據(jù)庫
【當發(fā)現(xiàn)問題時所使用數(shù)據(jù)庫的標識符。】
12.文件號
【有錯誤的文件的編號?!?/p>
13.測試用例
【發(fā)現(xiàn)錯誤時所使用測試用例的標識符?!?/p>
14.硬件
【發(fā)現(xiàn)錯誤時所使用的計算機系統(tǒng)的標識。】
15.問題描述/影響
【問題癥兆的詳細描述。如果可能,是寫明實際問題所在。也要給出該問題對將來測試、接口軟件和文件等的影響?!?/p>
16.附注
【記載補充信息?!?/p>
軟件修改報告
軟件修改報告
1.登記號
【由軟件配置管理部門為該報告規(guī)定的編號?!?/p>
2.登記日期
【軟件配置管理部門登記“軟件修改報告”的日期。】
3.時間
【準備好“軟件修改報告”的日期?!?/p>
4.報告人
【填寫該報告的作者?!?/p>
5.子系統(tǒng)名
【受修改影響的子系統(tǒng)名?!?/p>
6.模塊名
【被修改的模塊名?!?/p>
7.“軟件修改報告”的編號
【被“軟件修改報告”處理或部分處理的“軟件問題報告”的編號。如果某“軟件問題報告”的問題只是部分被處理,則在編號后附以p,如1234p?!?/p>
8.修改
【包括程序修改、文件更新、數(shù)據(jù)庫修改或它們的組合。】
9.修改描述
【修改的詳細描述。如果是文件更新或數(shù)據(jù)庫修改,還要列出文件更新通知或數(shù)據(jù)庫修改申請的標識符?!?/p>
10.批準人
【批準人簽字,正式批準進行修改。】
11.語句類型
【程序修改中涉及到的語句類型,包括:輸入/輸出語句類、計算語句類、邏輯控制語句類、數(shù)據(jù)處理語句類(如數(shù)據(jù)傳送、存取語句類)。】
12.程序名
【被修改的程序、文件或數(shù)據(jù)庫的名字。】
13.老修訂版
【當前的版本/修訂本標識?!?/p>
14.新修訂版
【修改后的版本/修訂本標識。】
15.數(shù)據(jù)庫
【如果申請數(shù)據(jù)庫修改,則給出數(shù)據(jù)庫的標識符?!?/p>
16.數(shù)據(jù)庫修改報告
【數(shù)據(jù)庫修改申請?zhí)??!?/p>
17.文件
【如果要求對文件進行修改,則給出文件的名字?!?/p>
18.文件更新
【文件更新通知單的編號?!?/p>
19.修改是否已測試
【指出已對修改做了哪些測試,如單元、子系統(tǒng)、組裝、確認和運行測試等,并注明測試成功與否。】
20.“軟件問題報告”是否給出問題的準確描述
【回答‘是’或‘否’。】
21.問題注釋
【準確地敘述要維護的問題。】
22.問題源
【指明問題來自于哪里,如軟件需求說明書、設(shè)計說明書、數(shù)據(jù)庫、源程序等?!?/p>
23.資源
【完成修改所需資源的估計,即總的人時數(shù)和計算機時間的開銷?!?/p>
程序維護手冊
程序維護手冊
引言
1.1編寫目的
【闡明編寫手冊的目的,指明讀者對象?!?/p>
1.2開發(fā)單位
【說明項目的提出者、開發(fā)者、用戶和使用場所?!?/p>
1.3定義
【列出報告中所用到的專門術(shù)語的定義和縮寫詞的原文。】
1.4參考資料
【列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源,以及保密級別,可包括:
a. 用戶操作手冊;
b. 與本項目有關(guān)的其他文檔?!?/p>
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)系?!?/p>
2.4程序說明
【說明系統(tǒng)中每一程序、分程序的細節(jié)和特性。】
2.4.1程序1的說明
2.4.1.1功能
【說明程序的功能。】
2.4.1.2方法
【說明實現(xiàn)方法?!?/p>
2.4.1.3輸入
【說明程序的輸入、媒體、運行數(shù)據(jù)記錄、運行開始時使用的輸入數(shù)據(jù)的類型和存放單元、與程序初始化有關(guān)的入口要求?!?/p>
2.4.1.4處理
【處理特點和目的,如:
a. 用圖表說明程序中的運行邏輯流程;
b. 程序主要轉(zhuǎn)移條件;
c. 對程序的約束條件;
d. 程序結(jié)束時的出口要求;
e. 與下一個程序的通信與聯(lián)結(jié)(運行、控制);
f. 由該程序產(chǎn)生并供處理程序段使用的輸出數(shù)據(jù)類型和存放單元;
g. 程序運行所用存儲量、類型及存儲位置等?!?/p>
2.4.1.5輸出
【程序的輸出。】
2.4.1.6接口
【本程序與本系統(tǒng)其他部分的接口?!?/p>
2.4.1.7表格
【說明程序內(nèi)部的各種表、項的細節(jié)和特性。對每張表的說明至少包括:
a. 表的標識符;
b. 使用目的;
c. 使用此表的其他程序;
d. 邏輯劃分,如塊或部,不包括表項;
e. 表的基本結(jié)構(gòu);
f. 設(shè)計安排,包括表的控制信息。表目結(jié)構(gòu)細節(jié)、使用中的特有性質(zhì)及各表項的標識、位置、用途、類型、編碼表示。】
2.4.1.8特有的運行性質(zhì)
【說明在用戶操作手冊中沒有提到的運行性質(zhì)?!?/p>
2.4.2程序2的說明
【與程序1的說明相同。以后其他各程序的說明相同?!?/p>
3.操作環(huán)境
3.1設(shè)備
【逐項說明系統(tǒng)的設(shè)備配置及其特性?!?/p>
3.2支持軟件
【列出系統(tǒng)使用的支持軟件,包括它們的名稱和版本號。】
3.3數(shù)據(jù)庫
【說明每個數(shù)據(jù)庫的性質(zhì)和內(nèi)容,包括安全考慮?!?/p>
3.3.1總體特征
【如:
a. 標識符;
b. 使用這些數(shù)據(jù)庫的程序;
c. 靜態(tài)數(shù)據(jù);
d. 動態(tài)數(shù)據(jù);
e. 數(shù)據(jù)庫的存儲媒體;
f. 程序使用數(shù)據(jù)庫的限制。】
3.3.2結(jié)構(gòu)及詳細說明
3.3.2.1說明該數(shù)據(jù)庫的結(jié)構(gòu),包括其中的記錄和項;
3.3.2.2說明記錄的組成,包括首部或控制段、記錄體;
3.3.2.3說明每個記錄結(jié)構(gòu)的字段,包括:標記或標號、字段的字符長度和位數(shù)、該字段的充許值范圍。
3.3.2.4擴充:說明為記錄追加字段的規(guī)定;
4.維護過程
4.1約定
【列出該軟件系統(tǒng)設(shè)計中所使用全部規(guī)則和約定,包括:
a. 程序、分程序、記錄、字段和存儲區(qū)的標識或標號助記符的使用規(guī)則;
b. 圖表的處理標準、卡片的連接順序、語句和記號中使用的縮寫、出現(xiàn)在圖表中的符號名;
c. 使用的軟件技術(shù)標準;
d. 標準化的數(shù)據(jù)元素及其特征?!?/p>
4.2驗證過程
【說明一個程序段修改后,對其進行驗證的要求和過程(包括測試程序和數(shù)據(jù))及程序周期性驗證的過程?!?/p>
4.3出錯及糾正方法
【列出出錯狀態(tài)及其糾正方法?!?/p>
4.4專門維護過程
【說明文檔其他地方?jīng)]有提到的專門維護過程,如:
a. 維護該軟件系統(tǒng)的輸入輸出部分(如數(shù)據(jù)庫)的要求、過程和驗證方法;
b. 運行程序庫維護系統(tǒng)所必需的要求、過程和驗證方法;
c. 對閏年、世紀變更所需的臨時性修改等?!?/p>
4.5專用維護程序
【列出維護軟件系統(tǒng)使用的后備技術(shù)和專用程序(如文件恢復(fù)程序、淘汰過時文件的程序等)的目錄,并加以說明,內(nèi)容包括:
a. 維護作業(yè)的輸入輸出要求;
b. 輸入的詳細過程及在硬設(shè)備上建立、運行并完成維護作業(yè)的操作步驟?!?/p>
4.6程序清單和流程圖
【引用資料或提供附錄給出程序清單和流程圖?!?/p>