項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告

項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告

引言

1.1編寫目的

【闡明編寫總結(jié)報(bào)告的目的，指明讀者對(duì)象?！?/p>

1.2項(xiàng)目背景

【說(shuō)明項(xiàng)目來(lái)源、委托單位、開(kāi)發(fā)單位及主管部門?！?/p>

1.3定義

【列出報(bào)告用到的專門術(shù)語(yǔ)的定義和縮寫詞的原文?！?/p>

1.4參考資料

【列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可包括：

a. 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文；

b. 項(xiàng)目開(kāi)發(fā)計(jì)劃；

c. 需求規(guī)格說(shuō)明書；

d. 概要設(shè)計(jì)說(shuō)明書；

e. 詳細(xì)設(shè)計(jì)說(shuō)明書；

f. 用戶操作手冊(cè)；

g. 測(cè)試計(jì)劃；

h. 測(cè)試分析報(bào)告；

i. 本報(bào)告引用的其他資料、采用的開(kāi)發(fā)標(biāo)準(zhǔn)或開(kāi)發(fā)規(guī)范?！?/p>

2．開(kāi)發(fā)結(jié)果

2.1產(chǎn)品

【可包括：

a. 列出各部分的程序名稱、源程序行數(shù)（包括注釋行）或目標(biāo)程序字節(jié)數(shù)及程序總計(jì)數(shù)量、存儲(chǔ)形式；

b. 產(chǎn)品文檔名稱等。】

2.2主要功能及性能

2.3所用工時(shí)

【按人員的不同層次分別計(jì)時(shí)。】

2.4所用機(jī)時(shí)

【按所用計(jì)算機(jī)機(jī)型分別計(jì)時(shí)?！?/p>

2.5進(jìn)度

【給出計(jì)劃進(jìn)度與實(shí)際進(jìn)度的對(duì)比?！?/p>

2.6費(fèi)用

3．評(píng)價(jià)

3.1生產(chǎn)率評(píng)價(jià)

【如平均每人每月生產(chǎn)的源程序行數(shù)、文檔的字?jǐn)?shù)等?！?/p>

3.2技術(shù)方案評(píng)價(jià)

3.3產(chǎn)品質(zhì)量評(píng)價(jià)

4．經(jīng)驗(yàn)與教訓(xùn)

用戶操作手冊(cè)

用戶操作手冊(cè)

引言

1.1編寫目的

【闡明編寫手冊(cè)的目的，指明讀者對(duì)象?！?/p>

1.2項(xiàng)目背景

【應(yīng)包括項(xiàng)目的來(lái)源、委托單位、開(kāi)發(fā)單位和主管部門。】

1.3定義

【列出手冊(cè)中所用到的專門術(shù)語(yǔ)的定義和縮寫詞的原文。】

1.4參考資料

【列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可包括：

a. 項(xiàng)目的計(jì)劃任務(wù)書、合同或批文；

b. 項(xiàng)目開(kāi)發(fā)計(jì)劃；

c. 需求規(guī)格說(shuō)明書；

d. 概要設(shè)計(jì)說(shuō)明書；

e. 詳細(xì)設(shè)計(jì)說(shuō)明書；

f. 測(cè)試計(jì)劃；

g. 手冊(cè)中引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范?！?/p>

2．軟件概述

2.1目標(biāo)

2.2功能

2.3性能

a. 數(shù)據(jù)精確度【包括輸入、輸出及處理數(shù)據(jù)的精度。】

b. 時(shí)間特性【如響應(yīng)時(shí)間、處理時(shí)間、數(shù)據(jù)傳輸時(shí)間等。】

c. 靈活性【在操作方式、運(yùn)行環(huán)境需做某些變更時(shí)軟件的適應(yīng)能力?！?/p>

3．運(yùn)行環(huán)境

3.1硬件

【列出軟件系統(tǒng)運(yùn)行時(shí)所需的硬件最小配置，如

a. 計(jì)算機(jī)型號(hào)、主存容量；

b. 外存儲(chǔ)器、媒體、記錄格式、設(shè)備型號(hào)及數(shù)量；

c. 輸入、輸出設(shè)備；

d. 數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號(hào)及數(shù)量?！?/p>

3.2支持軟件

【如：

a. 操作系統(tǒng)名稱及版本號(hào)；

b. 語(yǔ)言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號(hào)；

c. 數(shù)據(jù)庫(kù)管理系統(tǒng)的名稱及版本號(hào)；

d. 其他必要的支持軟件?！?/p>

4.使用說(shuō)明

4.1安裝和初始化

【給出程序的存儲(chǔ)形式、操作命令、反饋信息及其含意、表明安裝完成的測(cè)試實(shí)例以及安裝所需的軟件工具等?！?/p>

4.2輸入

【給出輸入數(shù)據(jù)或參數(shù)的要求?！?/p>

4.2.1數(shù)據(jù)背景

【說(shuō)明數(shù)據(jù)來(lái)源、存儲(chǔ)媒體、出現(xiàn)頻度、限制和質(zhì)量管理等?！?/p>

4.2.2數(shù)據(jù)格式

【如：

a. 長(zhǎng)度；

b. 格式基準(zhǔn)；

c. 標(biāo)號(hào)；

d. 順序；

e. 分隔符；

f. 詞匯表；

g. 省略和重復(fù)；

h. 控制。】

4.2.3輸入舉例

4.3輸出

【給出每項(xiàng)輸出數(shù)據(jù)的說(shuō)明?！?/p>

4.3.1數(shù)據(jù)背景

【說(shuō)明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。】

4.3.2數(shù)據(jù)格式

【詳細(xì)闡明每一輸出數(shù)據(jù)的格式，如：首部、主體和尾部的具體形式?！?/p>

4.3.3舉例

4.4出錯(cuò)和恢復(fù)

【給出：

a. 出錯(cuò)信息及其含意；

b. 用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動(dòng)?！?/p>

4.5求助查詢

【說(shuō)明如何操作。】

5.運(yùn)行說(shuō)明

5.1運(yùn)行表

【列出每種可能的運(yùn)行情況，說(shuō)明其運(yùn)行目的?！?/p>

5.2運(yùn)行步驟

【按順序說(shuō)明每種運(yùn)行的步驟，應(yīng)包括：】

5.2.1運(yùn)行控制

5.2.2操作信息

a. 運(yùn)行目的；

b. 操作要求；

c. 啟動(dòng)方法；

d. 預(yù)計(jì)運(yùn)行時(shí)間；

e. 操作命令格式及說(shuō)明；

f. 其他事項(xiàng)。

5.2.3輸入/輸出文件

【給出建立或更新文件的有關(guān)信息，如：】

a. 文件的名稱及編號(hào)；

b. 記錄媒體；

c. 存留的目錄；

d. 文件的支配【說(shuō)明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對(duì)象，占用硬件的優(yōu)先級(jí)及保密控制等?！?/p>

5.2.4啟動(dòng)或恢復(fù)過(guò)程

6.非常規(guī)過(guò)程

【提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯(cuò)處理操作、向后備系統(tǒng)切換操作以及維護(hù)人員須知的操作和注意事項(xiàng)?！?/p>

7.操作命令一覽表

【按字母順序逐個(gè)列出全部操作命令的格式、功能及參數(shù)說(shuō)明?！?/p>

8.程序文件（或命令文件）和數(shù)據(jù)文件一覽表

【按文件名字母順序或按功能與模塊分類順序逐個(gè)列出文件名稱、標(biāo)識(shí)符及說(shuō)明?！?/p>

9.用戶操作舉例

軟件問(wèn)題報(bào)告

軟件問(wèn)題報(bào)告

1. 登記號(hào)

【由軟件配置管理部門為該報(bào)告規(guī)定一個(gè)唯一的、順序的編號(hào)?！?/p>

2．登記日期

【軟件配置管理部門登記該報(bào)告的日期?！?/p>

3．問(wèn)題發(fā)現(xiàn)日期

【發(fā)現(xiàn)該問(wèn)題的日期和時(shí)間?！?/p>

4．活動(dòng)

【在哪個(gè)階段發(fā)現(xiàn)的問(wèn)題，分為單元測(cè)試、組裝測(cè)試、確認(rèn)測(cè)試和運(yùn)行維護(hù)。】

5．狀態(tài)

【在軟件配置記錄中維護(hù)的動(dòng)態(tài)指示，狀態(tài)表示有：

a. 正在復(fù)查“軟件問(wèn)題報(bào)告”，以確定將采取什么行動(dòng)；

b. 軟件問(wèn)題報(bào)告”已由指定的人去進(jìn)行處理；

c. 修改已完成，并經(jīng)過(guò)測(cè)試，正準(zhǔn)備交給主程序庫(kù)；

d. 主程序庫(kù)已經(jīng)更新，主程序庫(kù)修改的重新測(cè)試尚未完成；

e. 做了重新測(cè)試，問(wèn)題再現(xiàn)；

f. 做了重新測(cè)試，所做的修改已無(wú)故障，“軟件問(wèn)題報(bào)告”被關(guān)閉；

g. 留待以后關(guān)閉?！?/p>

6．報(bào)告人

【填寫“軟件問(wèn)題報(bào)告”人員的姓名、地址、電話?！?/p>

7．問(wèn)題屬于什么方面

【區(qū)分是程序的問(wèn)題，還是模塊的問(wèn)題，或是數(shù)據(jù)庫(kù)的問(wèn)題，文件的問(wèn)題。也可能是它們的某種組合?！?/p>

8．模塊/子系統(tǒng)

【出現(xiàn)的模塊名。如果不知是哪個(gè)模塊，可標(biāo)出子系統(tǒng)名，盡量給出細(xì)節(jié)。】

9．修訂版本號(hào)

【出現(xiàn)問(wèn)題的模塊版本。】

10．磁帶

【包含有問(wèn)題的模塊的主程序庫(kù)的磁帶的標(biāo)識(shí)符?！?/p>

11．?dāng)?shù)據(jù)庫(kù)

【當(dāng)發(fā)現(xiàn)問(wèn)題時(shí)所使用數(shù)據(jù)庫(kù)的標(biāo)識(shí)符?！?/p>

12．文件號(hào)

【有錯(cuò)誤的文件的編號(hào)?！?/p>

13．測(cè)試用例

【發(fā)現(xiàn)錯(cuò)誤時(shí)所使用測(cè)試用例的標(biāo)識(shí)符。】

14．硬件

【發(fā)現(xiàn)錯(cuò)誤時(shí)所使用的計(jì)算機(jī)系統(tǒng)的標(biāo)識(shí)?！?/p>

15．問(wèn)題描述/影響

【問(wèn)題癥兆的詳細(xì)描述。如果可能，是寫明實(shí)際問(wèn)題所在。也要給出該問(wèn)題對(duì)將來(lái)測(cè)試、接口軟件和文件等的影響?！?/p>

16．附注

【記載補(bǔ)充信息。】

軟件修改報(bào)告

軟件修改報(bào)告

1.登記號(hào)

【由軟件配置管理部門為該報(bào)告規(guī)定的編號(hào)。】

2．登記日期

【軟件配置管理部門登記“軟件修改報(bào)告”的日期?！?/p>

3．時(shí)間

【準(zhǔn)備好“軟件修改報(bào)告”的日期?！?/p>

4．報(bào)告人

【填寫該報(bào)告的作者?！?/p>

5．子系統(tǒng)名

【受修改影響的子系統(tǒng)名?！?/p>

6．模塊名

【被修改的模塊名?！?/p>

7．“軟件修改報(bào)告”的編號(hào)

【被“軟件修改報(bào)告”處理或部分處理的“軟件問(wèn)題報(bào)告”的編號(hào)。如果某“軟件問(wèn)題報(bào)告”的問(wèn)題只是部分被處理，則在編號(hào)后附以p，如1234p?！?/p>

8．修改

【包括程序修改、文件更新、數(shù)據(jù)庫(kù)修改或它們的組合?！?/p>

9．修改描述

【修改的詳細(xì)描述。如果是文件更新或數(shù)據(jù)庫(kù)修改，還要列出文件更新通知或數(shù)據(jù)庫(kù)修改申請(qǐng)的標(biāo)識(shí)符。】

10．批準(zhǔn)人

【批準(zhǔn)人簽字，正式批準(zhǔn)進(jìn)行修改?！?/p>

11．語(yǔ)句類型

【程序修改中涉及到的語(yǔ)句類型，包括：輸入/輸出語(yǔ)句類、計(jì)算語(yǔ)句類、邏輯控制語(yǔ)句類、數(shù)據(jù)處理語(yǔ)句類（如數(shù)據(jù)傳送、存取語(yǔ)句類）?！?/p>

12．程序名

【被修改的程序、文件或數(shù)據(jù)庫(kù)的名字?！?/p>

13．老修訂版

【當(dāng)前的版本/修訂本標(biāo)識(shí)?！?/p>

14．新修訂版

【修改后的版本/修訂本標(biāo)識(shí)?！?/p>

15．?dāng)?shù)據(jù)庫(kù)

【如果申請(qǐng)數(shù)據(jù)庫(kù)修改，則給出數(shù)據(jù)庫(kù)的標(biāo)識(shí)符。】

16．?dāng)?shù)據(jù)庫(kù)修改報(bào)告

【數(shù)據(jù)庫(kù)修改申請(qǐng)?zhí)??！?/p>

17．文件

【如果要求對(duì)文件進(jìn)行修改，則給出文件的名字?！?/p>

18．文件更新

【文件更新通知單的編號(hào)?！?/p>

19．修改是否已測(cè)試

【指出已對(duì)修改做了哪些測(cè)試，如單元、子系統(tǒng)、組裝、確認(rèn)和運(yùn)行測(cè)試等，并注明測(cè)試成功與否?！?/p>

20．“軟件問(wèn)題報(bào)告”是否給出問(wèn)題的準(zhǔn)確描述

【回答‘是’或‘否’?！?/p>

21．問(wèn)題注釋

【準(zhǔn)確地?cái)⑹鲆S護(hù)的問(wèn)題?！?/p>

22．問(wèn)題源

【指明問(wèn)題來(lái)自于哪里，如軟件需求說(shuō)明書、設(shè)計(jì)說(shuō)明書、數(shù)據(jù)庫(kù)、源程序等。】

23．資源

【完成修改所需資源的估計(jì)，即總的人時(shí)數(shù)和計(jì)算機(jī)時(shí)間的開(kāi)銷?！?/p>

程序維護(hù)手冊(cè)

程序維護(hù)手冊(cè)

引言

1.1編寫目的

【闡明編寫手冊(cè)的目的，指明讀者對(duì)象?！?/p>

1.2開(kāi)發(fā)單位

【說(shuō)明項(xiàng)目的提出者、開(kāi)發(fā)者、用戶和使用場(chǎng)所?！?/p>

1.3定義

【列出報(bào)告中所用到的專門術(shù)語(yǔ)的定義和縮寫詞的原文?！?/p>

1.4參考資料

【列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，以及保密級(jí)別，可包括：

a. 用戶操作手冊(cè)；

b. 與本項(xiàng)目有關(guān)的其他文檔?！?/p>

2．系統(tǒng)說(shuō)明

2.1系統(tǒng)用途

【說(shuō)明系統(tǒng)具備的功能，輸入和輸出?！?/p>

2.2安全保密

【說(shuō)明系統(tǒng)安全保密方面的考慮?！?/p>

2.3總體說(shuō)明

【說(shuō)明系統(tǒng)的總體功能，對(duì)系統(tǒng)、子系統(tǒng)和作業(yè)做出綜合性的介紹，并用圖表的方式給出系統(tǒng)主要部分的內(nèi)部關(guān)系?！?/p>

2.4程序說(shuō)明

【說(shuō)明系統(tǒng)中每一程序、分程序的細(xì)節(jié)和特性。】

2.4.1程序1的說(shuō)明

2.4.1.1功能

【說(shuō)明程序的功能?！?/p>

2.4.1.2方法

【說(shuō)明實(shí)現(xiàn)方法?！?/p>

2.4.1.3輸入

【說(shuō)明程序的輸入、媒體、運(yùn)行數(shù)據(jù)記錄、運(yùn)行開(kāi)始時(shí)使用的輸入數(shù)據(jù)的類型和存放單元、與程序初始化有關(guān)的入口要求?！?/p>

2.4.1.4處理

【處理特點(diǎn)和目的，如：

a. 用圖表說(shuō)明程序中的運(yùn)行邏輯流程；

b. 程序主要轉(zhuǎn)移條件；

c. 對(duì)程序的約束條件；

d. 程序結(jié)束時(shí)的出口要求；

e. 與下一個(gè)程序的通信與聯(lián)結(jié)（運(yùn)行、控制）；

f. 由該程序產(chǎn)生并供處理程序段使用的輸出數(shù)據(jù)類型和存放單元；

g. 程序運(yùn)行所用存儲(chǔ)量、類型及存儲(chǔ)位置等。】

2.4.1.5輸出

【程序的輸出?！?/p>

2.4.1.6接口

【本程序與本系統(tǒng)其他部分的接口?！?/p>

2.4.1.7表格

【說(shuō)明程序內(nèi)部的各種表、項(xiàng)的細(xì)節(jié)和特性。對(duì)每張表的說(shuō)明至少包括：

a. 表的標(biāo)識(shí)符；

b. 使用目的；

c. 使用此表的其他程序；

d. 邏輯劃分，如塊或部，不包括表項(xiàng)；

e. 表的基本結(jié)構(gòu)；

f. 設(shè)計(jì)安排，包括表的控制信息。表目結(jié)構(gòu)細(xì)節(jié)、使用中的特有性質(zhì)及各表項(xiàng)的標(biāo)識(shí)、位置、用途、類型、編碼表示?！?/p>

2.4.1.8特有的運(yùn)行性質(zhì)

【說(shuō)明在用戶操作手冊(cè)中沒(méi)有提到的運(yùn)行性質(zhì)?！?/p>

2.4.2程序2的說(shuō)明

【與程序1的說(shuō)明相同。以后其他各程序的說(shuō)明相同。】

3．操作環(huán)境

3.1設(shè)備

【逐項(xiàng)說(shuō)明系統(tǒng)的設(shè)備配置及其特性?！?/p>

3.2支持軟件

【列出系統(tǒng)使用的支持軟件，包括它們的名稱和版本號(hào)?！?/p>

3.3數(shù)據(jù)庫(kù)

【說(shuō)明每個(gè)數(shù)據(jù)庫(kù)的性質(zhì)和內(nèi)容，包括安全考慮?！?/p>

3.3.1總體特征

【如：

a. 標(biāo)識(shí)符；

b. 使用這些數(shù)據(jù)庫(kù)的程序；

c. 靜態(tài)數(shù)據(jù)；

d. 動(dòng)態(tài)數(shù)據(jù)；

e. 數(shù)據(jù)庫(kù)的存儲(chǔ)媒體；

f. 程序使用數(shù)據(jù)庫(kù)的限制?！?/p>

3.3.2結(jié)構(gòu)及詳細(xì)說(shuō)明

3.3.2.1說(shuō)明該數(shù)據(jù)庫(kù)的結(jié)構(gòu)，包括其中的記錄和項(xiàng)；

3.3.2.2說(shuō)明記錄的組成，包括首部或控制段、記錄體；

3.3.2.3說(shuō)明每個(gè)記錄結(jié)構(gòu)的字段，包括：標(biāo)記或標(biāo)號(hào)、字段的字符長(zhǎng)度和位數(shù)、該字段的充許值范圍。

3.3.2.4擴(kuò)充：說(shuō)明為記錄追加字段的規(guī)定；

4．維護(hù)過(guò)程

4.1約定

【列出該軟件系統(tǒng)設(shè)計(jì)中所使用全部規(guī)則和約定，包括：

a. 程序、分程序、記錄、字段和存儲(chǔ)區(qū)的標(biāo)識(shí)或標(biāo)號(hào)助記符的使用規(guī)則；

b. 圖表的處理標(biāo)準(zhǔn)、卡片的連接順序、語(yǔ)句和記號(hào)中使用的縮寫、出現(xiàn)在圖表中的符號(hào)名；

c. 使用的軟件技術(shù)標(biāo)準(zhǔn)；

d. 標(biāo)準(zhǔn)化的數(shù)據(jù)元素及其特征?！?/p>

4.2驗(yàn)證過(guò)程

【說(shuō)明一個(gè)程序段修改后，對(duì)其進(jìn)行驗(yàn)證的要求和過(guò)程（包括測(cè)試程序和數(shù)據(jù)）及程序周期性驗(yàn)證的過(guò)程?！?/p>

4.3出錯(cuò)及糾正方法

【列出出錯(cuò)狀態(tài)及其糾正方法?！?/p>

4.4專門維護(hù)過(guò)程

【說(shuō)明文檔其他地方?jīng)]有提到的專門維護(hù)過(guò)程，如：

a. 維護(hù)該軟件系統(tǒng)的輸入輸出部分（如數(shù)據(jù)庫(kù)）的要求、過(guò)程和驗(yàn)證方法；

b. 運(yùn)行程序庫(kù)維護(hù)系統(tǒng)所必需的要求、過(guò)程和驗(yàn)證方法；

c. 對(duì)閏年、世紀(jì)變更所需的臨時(shí)性修改等?！?/p>

4.5專用維護(hù)程序

【列出維護(hù)軟件系統(tǒng)使用的后備技術(shù)和專用程序（如文件恢復(fù)程序、淘汰過(guò)時(shí)文件的程序等）的目錄，并加以說(shuō)明，內(nèi)容包括：

a. 維護(hù)作業(yè)的輸入輸出要求；

b. 輸入的詳細(xì)過(guò)程及在硬設(shè)備上建立、運(yùn)行并完成維護(hù)作業(yè)的操作步驟?！?/p>

4.6程序清單和流程圖

【引用資料或提供附錄給出程序清單和流程圖?！?/p>