項目開發總結報告
項目開發總結報告
引言
1.1編寫目的
【闡明編寫總結報告的目的，指明讀者對象。】
1.2項目背景
【說明項目來源、委托機關、開發機關及主管部門。】
1.3定義
【列出報告用到的專門術語的定義和縮寫詞的原文。】
1.4參考資料
【列出有關資料的作者、标題、編号、發表日期、出版機關或資料來源，可包括：
a. 項目經核準的計劃任務書、合同或上級機關的批文；
b. 項目開發計劃；
c. 需求規格說明書；
d. 概要設計說明書；
e. 詳細設計說明書；
f. 使用者操作手冊；
g. 測試計劃；
h. 測試分析報告；
i. 本報告引用的其他資料、采用的開發标準或開發規範。】
2．開發結果
2.1産品
【可包括：
a. 列出各部分的程式名稱、源程式行數（包括注釋行）或目标程式位元組數及程式總計數量、存儲形式；
b. 産品文檔名稱等。】
2.2主要功能及性能
2.3所用工時
【按人員的不同層次分别計時。】
2.4所用機時
【按所用計算機機型分别計時。】
2.5進度
【給出計劃進度與實際進度的對比。】
2.6費用
3．評價
3.1生産率評價
【如平均每人每月生産的源程式行數、文檔的字數等。】
3.2技術方案評價
3.3産品品質評價
4．經驗與教訓
使用者操作手冊
使用者操作手冊
引言
1.1編寫目的
【闡明編寫手冊的目的，指明讀者對象。】
1.2項目背景
【應包括項目的來源、委托機關、開發機關和主管部門。】
1.3定義
【列出手冊中所用到的專門術語的定義和縮寫詞的原文。】
1.4參考資料
【列出有關資料的作者、标題、編号、發表日期、出版機關或資料來源，可包括：
a. 項目的計劃任務書、合同或批文；
b. 項目開發計劃；
c. 需求規格說明書；
d. 概要設計說明書；
e. 詳細設計說明書；
f. 測試計劃；
g. 手冊中引用的其他資料、采用的軟體工程标準或軟體工程規範。】
2．軟體概述
2.1目标
2.2功能
2.3性能
a. 資料精确度【包括輸入、輸出及處理資料的精度。】
b. 時間特性【如響應時間、處理時間、資料傳輸時間等。】
c. 靈活性【在操作方式、運作環境需做某些變更時軟體的适應能力。】
3．運作環境
3.1硬體
【列出軟體系統運作時所需的硬體最小配置，如
a. 計算機型号、主存容量；
b. 外存儲器、媒體、記錄格式、裝置型号及數量；
c. 輸入、輸出裝置；
d. 資料傳輸裝置及資料轉換裝置的型号及數量。】
3.2支援軟體
【如：
a. 作業系統名稱及版本号；
b. 語言編譯系統或彙編系統的名稱及版本号；
c. 資料庫管理系統的名稱及版本号；
d. 其他必要的支援軟體。】
4.使用說明
4.1安裝和初始化
【給出程式的存儲形式、操作指令、回報資訊及其含意、表明安裝完成的測試執行個體以及安裝所需的軟體工具等。】
4.2輸入
【給出輸入資料或參數的要求。】
4.2.1資料背景
【說明資料來源、存儲媒體、出現頻度、限制和品質管理等。】
4.2.2資料格式
【如：
a. 長度；
b. 格式基準；
c. 标号；
d. 順序；
e. 分隔符；
f. 詞彙表；
g. 省略和重複；
h. 控制。】
4.2.3輸入舉例
4.3輸出
【給出每項輸出資料的說明。】
4.3.1資料背景
【說明輸出資料的去向、使用頻度、存放媒體及品質管理等。】
4.3.2資料格式
【詳細闡明每一輸出資料的格式，如：首部、主體和尾部的具體形式。】
4.3.3舉例
4.4出錯和恢複
【給出：
a. 出錯資訊及其含意；
b. 使用者應采取的措施，如修改、恢複、再啟動。】
4.5求助查詢
【說明如何操作。】
5.運作說明
5.1運作表
【列出每種可能的運作情況，說明其運作目的。】
5.2運作步驟
【按順序說明每種運作的步驟，應包括：】
5.2.1運作控制
5.2.2操作資訊
a. 運作目的；
b. 操作要求；
c. 啟動方法；
d. 預計運作時間；
e. 操作指令格式及說明；
f. 其他事項。
5.2.3輸入/輸出檔案
【給出建立或更新檔案的有關資訊，如：】
a. 檔案的名稱及編号；
b. 記錄媒體；
c. 存留的目錄；
d. 檔案的支配【說明确定保留檔案或廢棄檔案的準則，分發檔案的對象，占用硬體的優先級及保密控制等。】
5.2.4啟動或恢複過程
6.非正常過程
【提供應急或非正常操作的必要資訊及操作步驟，如出錯處理操作、向後備系統切換操作以及維護人員須知的操作和注意事項。】
7.操作指令一覽表
【按字母順序逐個列出全部操作指令的格式、功能及參數說明。】
8.程式檔案（或指令檔案）和資料檔案一覽表
【按檔案名字母順序或按功能與子產品分類順序逐個列出檔案名稱、辨別符及說明。】
9.使用者操作舉例
軟體問題報告
軟體問題報告
1. 登記号
【由軟體配置管理部門為該報告規定一個唯一的、順序的編号。】
2．登記日期
【軟體配置管理部門登記該報告的日期。】
3．問題發現日期
【發現該問題的日期和時間。】
4．活動
【在哪個階段發現的問題，分為單元測試、組裝測試、确認測試和運作維護。】
5．狀态
【在軟體配置記錄中維護的動态訓示，狀态表示有：
a. 正在複查“軟體問題報告”，以确定将采取什麼行動；
b. 軟體問題報告”已由指定的人去進行處理；
c. 修改已完成，并經過測試，正準備交給主程式庫；
d. 主程式庫已經更新，主程式庫修改的重新測試尚未完成；
e. 做了重新測試，問題再現；
f. 做了重新測試，所做的修改已無故障，“軟體問題報告”被關閉；
g. 留待以後關閉。】
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．資源
【完成修改所需資源的估計，即總的人時數和計算機時間的開銷。】
程式維護手冊
程式維護手冊
引言
1.1編寫目的
【闡明編寫手冊的目的，指明讀者對象。】
1.2開發機關
【說明項目的提出者、開發者、使用者和使用場所。】
1.3定義
【列出報告中所用到的專門術語的定義和縮寫詞的原文。】
1.4參考資料
【列出有關資料的作者、标題、編号、發表日期、出版機關或資料來源，以及保密級别，可包括：
a. 使用者操作手冊；
b. 與本項目有關的其他文檔。】
2．系統說明
2.1系統用途
【說明系統具備的功能，輸入和輸出。】
2.2安全保密
【說明系統安全保密方面的考慮。】
2.3總體說明
【說明系統的總體功能，對系統、子系統和作業做出綜合性的介紹，并用圖表的方式給出系統主要部分的内部關系。】
2.4程式說明
【說明系統中每一程式、分程式的細節和特性。】
2.4.1程式1的說明
2.4.1.1功能
【說明程式的功能。】
2.4.1.2方法
【說明實作方法。】
2.4.1.3輸入
【說明程式的輸入、媒體、運作資料記錄、運作開始時使用的輸入資料的類型和存放單元、與程式初始化有關的入口要求。】
2.4.1.4處理
【處理特點和目的，如：
a. 用圖表說明程式中的運作邏輯流程；
b. 程式主要轉移條件；
c. 對程式的限制條件；
d. 程式結束時的出口要求；
e. 與下一個程式的通信與聯結（運作、控制）；
f. 由該程式産生并供處理程式段使用的輸出資料類型和存放單元；
g. 程式運作所用存儲量、類型及存儲位置等。】
2.4.1.5輸出
【程式的輸出。】
2.4.1.6接口
【本程式與本系統其他部分的接口。】
2.4.1.7表格
【說明程式内部的各種表、項的細節和特性。對每張表的說明至少包括：
a. 表的辨別符；
b. 使用目的；
c. 使用此表的其他程式；
d. 邏輯劃分，如塊或部，不包括表項；
e. 表的基本結構；
f. 設計安排，包括表的控制資訊。表目結構細節、使用中的特有性質及各表項的辨別、位置、用途、類型、編碼表示。】
2.4.1.8特有的運作性質
【說明在使用者操作手冊中沒有提到的運作性質。】
2.4.2程式2的說明
【與程式1的說明相同。以後其他各程式的說明相同。】
3．操作環境
3.1裝置
【逐項說明系統的裝置配置及其特性。】
3.2支援軟體
【列出系統使用的支援軟體，包括它們的名稱和版本号。】
3.3資料庫
【說明每個資料庫的性質和内容，包括安全考慮。】
3.3.1總體特征
【如：
a. 辨別符；
b. 使用這些資料庫的程式；
c. 靜态資料；
d. 動态資料；
e. 資料庫的存儲媒體；
f. 程式使用資料庫的限制。】
3.3.2結構及詳細說明
3.3.2.1說明該資料庫的結構，包括其中的記錄和項；
3.3.2.2說明記錄的組成，包括首部或控制段、記錄體；
3.3.2.3說明每個記錄結構的字段，包括：标記或标号、字段的字元長度和位數、該字段的充許值範圍。
3.3.2.4擴充：說明為記錄追加字段的規定；
4．維護過程
4.1約定
【列出該軟體系統設計中所使用全部規則和約定，包括：
a. 程式、分程式、記錄、字段和存儲區的辨別或标号助記符的使用規則；
b. 圖表的處理标準、卡片的連接配接順序、語句和記号中使用的縮寫、出現在圖表中的符号名；
c. 使用的軟體技術标準；
d. 标準化的資料元素及其特征。】
4.2驗證過程
【說明一個程式段修改後，對其進行驗證的要求和過程（包括測試程式和資料）及程式周期性驗證的過程。】
4.3出錯及糾正方法
【列出出錯狀态及其糾正方法。】
4.4專門維護過程
【說明文檔其他地方沒有提到的專門維護過程，如：
a. 維護該軟體系統的輸入輸出部分（如資料庫）的要求、過程和驗證方法；
b. 運作程式庫維護系統所必需的要求、過程和驗證方法；
c. 對閏年、世紀變更所需的臨時性修改等。】
4.5專用維護程式
【列出維護軟體系統使用的後備技術和專用程式（如檔案恢複程式、淘汰過時檔案的程式等）的目錄，并加以說明，内容包括：
a. 維護作業的輸入輸出要求；
b. 輸入的詳細過程及在硬裝置上建立、運作并完成維護作業的操作步驟。】
4.6程式清單和流程圖
【引用資料或提供附錄給出程式清單和流程圖。】