關(guān)注【本頭條號(hào)】更多關(guān)于制度、流程、體系、崗位、模板、方案、工具、案例、故事、圖書(shū)、文案、報(bào)告、技能、職場(chǎng)等內(nèi)容，弗布克15年積累免費(fèi)與您分享！

閱讀導(dǎo)航→

01 軟件研發(fā)計(jì)劃書(shū)

02 軟件需求說(shuō)明書(shū)

03 詳細(xì)設(shè)計(jì)說(shuō)明書(shū)

04 用戶操作手冊(cè)

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

06 軟件研發(fā)總結(jié)報(bào)告

研發(fā)部

一、軟件研發(fā)計(jì)劃書(shū)

軟件研發(fā)計(jì)劃書(shū)（撰寫(xiě)指引）

一、引言

（一）編寫(xiě)目的

本報(bào)告的主要作用是確定各個(gè)研發(fā)階段的研發(fā)情況和主要的負(fù)責(zé)人，有序進(jìn)行項(xiàng)目的研發(fā)，減少研發(fā)中的不必要損失。

（二）背景介紹

1．待開(kāi)發(fā)的軟件系統(tǒng)名稱。

2．本軟件研發(fā)提出者、開(kāi)發(fā)者、用戶及實(shí)現(xiàn)該軟件的計(jì)算中心或計(jì)算機(jī)網(wǎng)絡(luò)。

3．該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)基本的相互來(lái)往關(guān)系。

（三）定義

列出本文件中用到的專門(mén)術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。

（四）參考資料

1．本次研發(fā)項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同及有關(guān)部門(mén)的批文。

2．屬于本次研發(fā)項(xiàng)目的其他已發(fā)表的文件。

3．列出本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的路徑。

二、研發(fā)工作概述

（一）工作內(nèi)容

簡(jiǎn)要說(shuō)明在本次研發(fā)中必須進(jìn)行的各項(xiàng)主要工作。

（二）主要參加人員

扼要說(shuō)明參加本項(xiàng)目開(kāi)發(fā)工作的主要人員情況，包括他們的技術(shù)水平。

（三）條件與限制

1．完成項(xiàng)目應(yīng)具備的條件。

2．研發(fā)部已具有的條件。

3．尚需創(chuàng)造的條件。

（四）產(chǎn)品

1．程序。列出需移交給用戶的程序的名稱、所用的編程語(yǔ)言及存儲(chǔ)形式，并通過(guò)引用有關(guān)文件逐項(xiàng)說(shuō)明其功能和特性。

2．文件。列出需移交給用戶的每種文件的名稱及內(nèi)容要點(diǎn)。

3．服務(wù)。列出需向用戶提供的各項(xiàng)服務(wù)，如安裝培訓(xùn)、維護(hù)與運(yùn)行支持等，應(yīng)逐項(xiàng)規(guī)定開(kāi)始日期、所提供支持的級(jí)別和服務(wù)的期限。

4．非移交的產(chǎn)品。說(shuō)明開(kāi)發(fā)集體應(yīng)向本單位交出但不必向用戶移交的產(chǎn)品（文件甚至某些程序）。

（五）驗(yàn)收標(biāo)準(zhǔn)

對(duì)于上述這些應(yīng)交出的產(chǎn)品和服務(wù)，逐項(xiàng)說(shuō)明或引用資料說(shuō)明驗(yàn)收標(biāo)準(zhǔn)。

（六）項(xiàng)目交付期限

（七）本計(jì)劃的批準(zhǔn)者和批準(zhǔn)日期

三、研發(fā)實(shí)施計(jì)劃

（一）工作任務(wù)的分解與人員分工

對(duì)于項(xiàng)目開(kāi)發(fā)中需完成的各項(xiàng)工作，從需求分析、設(shè)計(jì)、實(shí)現(xiàn)、測(cè)試直到維護(hù)，包括文件的編制、審批、打印、分發(fā)工作，用戶培訓(xùn)工作，軟件安裝工作等，按層次進(jìn)行分解，指明每項(xiàng)任務(wù)的負(fù)責(zé)人和參加人員。

（二）接口人員

說(shuō)明負(fù)責(zé)接口工作的人員及其職責(zé)，接口人員包括以下三類人員。

1．負(fù)責(zé)本項(xiàng)目同用戶接口的人員。

2．負(fù)責(zé)本項(xiàng)目同本公司各管理機(jī)構(gòu)，如財(cái)務(wù)部門(mén)、質(zhì)量管理部等部門(mén)接口的人員。

3．負(fù)責(zé)本項(xiàng)目同各分合同負(fù)責(zé)單位接口的人員等。

（三）進(jìn)度控制

編制工作列表，對(duì)于需求分析、設(shè)計(jì)、編碼實(shí)現(xiàn)、測(cè)試、移交、培訓(xùn)和安裝等工作階段，給出每項(xiàng)工作任務(wù)的預(yù)定開(kāi)始日期、完成日期及所需的資源，規(guī)定各項(xiàng)工作任務(wù)完成的先后順序以及表征每項(xiàng)工作任務(wù)完成的標(biāo)志性事件。

（四）預(yù)算管理

逐項(xiàng)列出本開(kāi)發(fā)項(xiàng)目所需要的勞務(wù)（包括人員數(shù)量和時(shí)間）以及經(jīng)費(fèi)的預(yù)算（包括辦公費(fèi)、差旅費(fèi)、機(jī)時(shí)費(fèi)、資料費(fèi)、通訊設(shè)備與專用設(shè)備的租金等）和來(lái)源。

（五）關(guān)鍵問(wèn)題與難點(diǎn)

逐項(xiàng)列出能夠影響整個(gè)項(xiàng)目成敗的關(guān)鍵問(wèn)題和技術(shù)難點(diǎn)，指出這些問(wèn)題對(duì)項(xiàng)目的影響。

（六）風(fēng)險(xiǎn)管理

清晰列出存在的風(fēng)險(xiǎn)及應(yīng)急方案。

四、支持條件

說(shuō)明為支持本次研發(fā)工作所需要的各種條件和設(shè)施。

（一）計(jì)算機(jī)系統(tǒng)支持

逐項(xiàng)列出研發(fā)過(guò)程中和運(yùn)行時(shí)所需的計(jì)算機(jī)系統(tǒng)支持，包括計(jì)算機(jī)、外圍設(shè)備、通訊設(shè)備、模擬器、編譯（或匯編）程序、操作系統(tǒng)、數(shù)據(jù)管理程序包、數(shù)據(jù)存儲(chǔ)能力和測(cè)試支持能力等，逐項(xiàng)給出有關(guān)到貨日期和使用時(shí)間的要求。

（二）需要用戶承擔(dān)的工作

逐項(xiàng)列出需要用戶承擔(dān)的工作和完成期限，包括需要用戶提供的條件及提供的時(shí)間。

（三）由外單位提供的條件

逐項(xiàng)列出需要外單位分合同承包者承擔(dān)的工作和完成的時(shí)間，包括需要由外單位提供的條件和提供的時(shí)間。

（四）專題計(jì)劃要點(diǎn)

說(shuō)明本次研發(fā)中需制訂的各個(gè)專題計(jì)劃（如分合同計(jì)劃、研發(fā)人員培訓(xùn)計(jì)劃、測(cè)試計(jì)劃、安全保密計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、用戶培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等）的要點(diǎn)。

二、軟件需求說(shuō)明書(shū)

軟件需求說(shuō)明書(shū)（撰寫(xiě)指引）

一、引言

（一）編寫(xiě)目的

說(shuō)明編寫(xiě)這份需求說(shuō)明書(shū)的目的，指出預(yù)期的閱讀范圍。

（二）背景說(shuō)明

1．本項(xiàng)目的名稱和所開(kāi)發(fā)出來(lái)的軟件系統(tǒng)的名稱。

2．此軟件的任務(wù)提出者、開(kāi)發(fā)者、用戶等。

（三）定義

列出本文件中用到的專門(mén)術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。

（四）參考資料

列出要用到的參考資料。

1．本項(xiàng)目已核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同及上級(jí)機(jī)關(guān)的批文。

2．屬于本項(xiàng)目的其他已發(fā)表的文件。

3．本文件中各處所引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)，列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的路徑。

（五）說(shuō)明實(shí)際參加人員、時(shí)間及工作劃分

說(shuō)明參加本次研發(fā)工作的負(fù)責(zé)人、參加人員、起止時(shí)間及實(shí)際工作量。按研發(fā)階段劃分，細(xì)化每位研發(fā)人員在各研發(fā)階段所用的研發(fā)時(shí)間及實(shí)際工作量。

二、任務(wù)概述

（一）目標(biāo)

1．?dāng)⑹鲈擁?xiàng)軟件研發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其他背景材料。

2．解釋被研發(fā)軟件與其他有關(guān)軟件之間的關(guān)系。

（1）如果本軟件產(chǎn)品是一項(xiàng)獨(dú)立的軟件，而且全部?jī)?nèi)容自含，則應(yīng)說(shuō)明這一點(diǎn)。

（2）如果所定義的產(chǎn)品是一個(gè)更大的系統(tǒng)的一個(gè)組成部分，則應(yīng)說(shuō)明本產(chǎn)品與該系統(tǒng)中其他各組成部分之間的關(guān)系。

（二）用戶的特點(diǎn)

列出本軟件最終用戶的特點(diǎn)，充分說(shuō)明操作人員、維護(hù)人員的受教育水平和技術(shù)專長(zhǎng)以及本軟件的預(yù)期使用頻度。

（三）假定和約束條件

列出進(jìn)行本軟件開(kāi)發(fā)工作的假定和約束條件，例如經(jīng)費(fèi)限制、開(kāi)發(fā)期限等。

三、需求規(guī)定

（一）對(duì)功能的規(guī)定

用列表的方式（例如IPO表即輸入、處理、輸出表的形式），逐項(xiàng)定量、定性地?cái)⑹鰧?duì)軟件提出的功能要求，說(shuō)明輸入什么、經(jīng)怎樣的處理、得到什么輸出，說(shuō)明軟件應(yīng)支持的終端數(shù)和應(yīng)支持的并行操作的用戶數(shù)。

（二）對(duì)性能的規(guī)定

1．精度

說(shuō)明對(duì)該軟件的輸入、輸出數(shù)據(jù)的精度要求，包括傳輸過(guò)程中的精度。

2．時(shí)間特性要求

說(shuō)明對(duì)于該軟件的時(shí)間特性要求，包括響應(yīng)時(shí)間、更新處理時(shí)間、數(shù)據(jù)轉(zhuǎn)換與傳送時(shí)間、解題時(shí)間等。

3．靈活性

說(shuō)明對(duì)該軟件的靈活性要求，即當(dāng)需求發(fā)生某些變化時(shí)，該軟件對(duì)這些變化的適應(yīng)能力。

（1）操作方式上的變化。

（2）運(yùn)行環(huán)境的變化。

（3）同其他軟件的接口的變化。

（4）精度和有效時(shí)限的變化。

（5）計(jì)劃的變化或改進(jìn)。

（6）對(duì)于為了提供這些靈活性而進(jìn)行的專門(mén)設(shè)計(jì)的部分應(yīng)該加以標(biāo)明。

（三）輸入輸出要求

1．解釋各輸入輸出數(shù)據(jù)的類型，并逐項(xiàng)說(shuō)明其媒體、格式、數(shù)值范圍、精度等。

2．對(duì)軟件的數(shù)據(jù)輸出及必須標(biāo)明的控制輸出量進(jìn)行解釋并舉例，包括對(duì)硬拷貝報(bào)告（正常結(jié)果輸出、狀態(tài)輸出及異常輸出）以及圖形或顯示報(bào)告的描述。

（四）數(shù)據(jù)管理能力要求

說(shuō)明需要管理的文卷和記錄的個(gè)數(shù)、表和文卷的大小規(guī)模，要按可預(yù)見(jiàn)的增長(zhǎng)對(duì)數(shù)據(jù)及其分量的存儲(chǔ)要求做出估算。

（五）故障處理要求

列出可能的軟件、硬件故障以及對(duì)各項(xiàng)性能而言所產(chǎn)生的后果和對(duì)故障處理的要求。

（六）其他專門(mén)要求

如用戶單位對(duì)安全保密的要求，對(duì)使用方便的要求，對(duì)可維護(hù)性、可補(bǔ)充性、易讀性、可靠性、運(yùn)行環(huán)境可轉(zhuǎn)換性的特殊要求等。

四、運(yùn)行環(huán)境規(guī)定

（一）設(shè)備

列出運(yùn)行該軟件所需要的硬設(shè)備，說(shuō)明其中的新型設(shè)備及其專門(mén)功能，包括以下五個(gè)方面的內(nèi)容。

1．處理器型號(hào)及內(nèi)存容量。

2．外存容量、聯(lián)機(jī)或脫機(jī)、媒體及其存儲(chǔ)格式、設(shè)備的型號(hào)及數(shù)量。

3．輸入及輸出設(shè)備的型號(hào)和數(shù)量、聯(lián)機(jī)或脫機(jī)。

4．?dāng)?shù)據(jù)通信設(shè)備的型號(hào)和數(shù)量。

5．功能鍵及其他專用硬件。

（二）支持軟件

列出支持軟件，包括要用到的操作系統(tǒng)、編譯（或匯編）程序、測(cè)試支持軟件等。

（三）接口

說(shuō)明該軟件同其他軟件之間的接口、數(shù)據(jù)通信協(xié)議等。

（四）控制

說(shuō)明控制該軟件的運(yùn)行方法和控制信號(hào)，并說(shuō)明這些控制信號(hào)的來(lái)源。

研發(fā)部

三、詳細(xì)設(shè)計(jì)說(shuō)明書(shū)

詳細(xì)設(shè)計(jì)說(shuō)明書(shū)（撰寫(xiě)指引）

一、引言

（一）編寫(xiě)目的

說(shuō)明編寫(xiě)這份詳細(xì)設(shè)計(jì)說(shuō)明書(shū)的目的，指出預(yù)期的讀者。

（二）項(xiàng)目背景

（三）文中特殊的定義與縮寫(xiě)

（四）參考資料

1．軟件研發(fā)計(jì)劃書(shū)。

2．需求規(guī)格說(shuō)明書(shū)。

3．概要設(shè)計(jì)說(shuō)明書(shū)。

二、總體設(shè)計(jì)

1．需求概要。

2．軟件結(jié)構(gòu)。

三、程序1（××模塊）設(shè)計(jì)說(shuō)明

（一）程序描述

給出對(duì)該程序的簡(jiǎn)要描述，主要說(shuō)明安排設(shè)計(jì)本程序的目的和意義，并說(shuō)明本程序的特點(diǎn)。

（二）功能

說(shuō)明該程序應(yīng)具有的功能，可采用IPO圖（即輸入—處理—輸出圖）的形式。

（三）性能

說(shuō)明對(duì)該程序的全部性能要求，包括對(duì)精度、靈活性和時(shí)間特性的要求。

（四）輸入項(xiàng)

給出對(duì)每一個(gè)輸入項(xiàng)的特性說(shuō)明，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍，輸入的方式、數(shù)量和頻度，輸入媒體，輸入數(shù)據(jù)的來(lái)源，安全保密條件，等等。

（五）輸出項(xiàng)

給出對(duì)每一個(gè)輸出項(xiàng)的特性說(shuō)明，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍，輸出的形式、數(shù)量和頻度，輸出媒體，對(duì)輸出圖形及符號(hào)的說(shuō)明，安全保密條件，等等。

（六）算法

詳細(xì)說(shuō)明本程序所選用的算法，及具體的計(jì)算公式和計(jì)算步驟。

（七）流程邏輯

用圖表（例如流程圖、判定表等）輔以必要的說(shuō)明來(lái)表示本程序的邏輯流程。

（八）接口

用圖的形式說(shuō)明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序，說(shuō)明參數(shù)賦值和調(diào)用方式，說(shuō)明與本程序直接相關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)（數(shù)據(jù)庫(kù)、數(shù)據(jù)文卷）。

（九）存儲(chǔ)分配

根據(jù)需要，說(shuō)明本程序的存儲(chǔ)分配。

（十）注釋設(shè)計(jì)

說(shuō)明準(zhǔn)備在本程序中安排的注釋。

1．加在模塊首部的注釋。

2．加在各分支點(diǎn)處的注釋。

3．對(duì)各變量的功能、范圍、缺省條件等所加的注釋。

4．對(duì)使用的邏輯所加的注釋。

（十一）限制條件

說(shuō)明本程序運(yùn)行中所受到的限制條件。

（十二）測(cè)試計(jì)劃

說(shuō)明對(duì)本程序進(jìn)行單體測(cè)試的計(jì)劃，包括對(duì)測(cè)試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安排、人員職責(zé)、設(shè)備條件驅(qū)動(dòng)程序及模塊等的規(guī)定。

（十三）尚未解決的問(wèn)題

說(shuō)明在本程序的設(shè)計(jì)中尚未解決并且設(shè)計(jì)者認(rèn)為在軟件完成之前應(yīng)解決的問(wèn)題。

四、程序2（××模塊）設(shè)計(jì)說(shuō)明

用類似程序1（××模塊）的方式，詳細(xì)說(shuō)明程序2（××模塊）乃至第n個(gè)程序的設(shè)計(jì)思路。

四、用戶操作手冊(cè)

用戶操作手冊(cè)（撰寫(xiě)指引）

一、引言

（一）編寫(xiě)目的

（二）背景

（三）定義

（四）參考資料

二、用途

（一）功能

結(jié)合本軟件的研發(fā)目的逐項(xiàng)說(shuō)明本軟件所具有的各項(xiàng)功能以及它們的極限范圍。

（二）性能

1．精度，即逐項(xiàng)說(shuō)明對(duì)各項(xiàng)輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達(dá)到的精度，包括傳輸中的精度要求。

2．時(shí)間特性，定量說(shuō)明本軟件的時(shí)間特性，如響應(yīng)時(shí)間、更新處理時(shí)間、數(shù)據(jù)傳輸轉(zhuǎn)換時(shí)間、計(jì)算時(shí)間等。

3．靈活性，說(shuō)明本軟件所具有的靈活性，即當(dāng)用戶需求（如對(duì)操作方式、運(yùn)行環(huán)境、結(jié)果精度、時(shí)間特性等的要求）發(fā)生某些變化時(shí)，本軟件的適應(yīng)能力。

（三）安全保密

說(shuō)明本軟件在安全、保密方面的設(shè)計(jì)考慮和實(shí)際達(dá)到的能力。

三、運(yùn)行環(huán)境

（一）硬設(shè)備

列出為運(yùn)行本軟件所需要的硬設(shè)備的最小配置，主要有以下四個(gè)方面的內(nèi)容。

1．處理機(jī)的型號(hào)、內(nèi)存容量。

2．所需要的外存儲(chǔ)器、媒體、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)。

3．聯(lián)機(jī)或者脫機(jī)。

4．?dāng)?shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。

（二）支持軟件

說(shuō)明為運(yùn)行本軟件所需要的支持軟件，主要有以下四種類型。

1．操作系統(tǒng)的名稱、版本號(hào)。

2．程序語(yǔ)言的編譯/匯編系統(tǒng)的名稱和版本號(hào)。

3．?dāng)?shù)據(jù)庫(kù)管理系統(tǒng)的名稱和版本號(hào)。

4．其他支持軟件。

（三）數(shù)據(jù)結(jié)構(gòu)

列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫(kù)或數(shù)據(jù)文卷。

四、使用過(guò)程說(shuō)明

（一）安裝與初始化

一步一步地說(shuō)明為使用本軟件而需進(jìn)行的安裝與初始化過(guò)程，包括程序的存儲(chǔ)形式、安裝與初始化過(guò)程中的全部操作命令、系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)、表征安裝工作完成的測(cè)試實(shí)例等。如果有的話，還應(yīng)說(shuō)明安裝過(guò)程中所需用到的專用軟件。

（二）輸入

規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。

1．輸入數(shù)據(jù)的現(xiàn)實(shí)背景

（1）實(shí)際情況。

（2）情況出現(xiàn)的頻度。

（3）情況來(lái)源。

（4）輸入媒體。

（5）出于安全保密考慮而對(duì)訪問(wèn)這些輸入數(shù)據(jù)所加的限制。

（6）質(zhì)量管理，例如對(duì)輸入數(shù)據(jù)合理性的檢驗(yàn)以及當(dāng)輸入數(shù)據(jù)有錯(cuò)誤時(shí)應(yīng)采取的措施，如建立出錯(cuò)情況的記錄等。

（7）支配，例如，如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。

2．輸入格式

（1）說(shuō)明對(duì)初始輸入數(shù)據(jù)和參量的格式要求，包括語(yǔ)法規(guī)則、數(shù)據(jù)長(zhǎng)度、格式基準(zhǔn)、標(biāo)號(hào)、順序、標(biāo)點(diǎn)、詞匯表、省略和重復(fù)等方面的要求。

（2）給出用來(lái)表示輸入開(kāi)始或結(jié)束的控制信息。

3．輸入舉例

為每個(gè)完整的輸入形式提供樣本，包括以下五個(gè)方面。

（1）控制或首部，例如用來(lái)表示輸入種類和類型的信息、標(biāo)識(shí)符輸入日期、正文起點(diǎn)和對(duì)所用編碼的規(guī)定。

（2）主體，輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分。

（3）尾部，用來(lái)表示輸入結(jié)束的控制信息、累計(jì)字符總數(shù)等。

（4）省略，指出哪些輸入數(shù)據(jù)是可省略的。

（5）重復(fù)，指出哪些輸入數(shù)據(jù)是重復(fù)的。

（三）輸出

1．輸出數(shù)據(jù)的現(xiàn)實(shí)背景，說(shuō)明輸出數(shù)據(jù)的現(xiàn)實(shí)背景。

（1）使用，這些輸出數(shù)據(jù)是給誰(shuí)的，用來(lái)干什么的。

（2）使用頻度，例如每周的、定期的或備查的。

（3）媒介，如打印、CRI顯示、磁帶、卡片、磁盤(pán)。

（4）質(zhì)量管理，例如關(guān)于合理性檢驗(yàn)、出錯(cuò)糾正的規(guī)定。

（5）支配，例如，如何確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受者等。

2．輸出格式

給出對(duì)每一類輸出信息的解釋。

（1）首部，如輸出數(shù)據(jù)的標(biāo)識(shí)符、輸出日期和輸出編號(hào)。

（2）主體，輸出信息的主體，包括分欄標(biāo)題。

（3）尾部，包括累計(jì)總數(shù)和結(jié)束標(biāo)記。

3．輸出舉例

為每種輸出類型提供例子，并對(duì)例子中的每一項(xiàng)進(jìn)行說(shuō)明。

（1）定義，每項(xiàng)輸出信息的意義和用途。

（2）來(lái)源，是從特定輸入中抽出、從數(shù)據(jù)庫(kù)文卷中取出，還是從軟件的計(jì)算過(guò)程中得到。

（3）特性，輸出的值域、計(jì)量單位以及在什么情況下可缺省等。

（四）文卷查詢

這一條的編寫(xiě)針對(duì)具有查詢能力的軟件，內(nèi)容包括同數(shù)據(jù)庫(kù)查詢有關(guān)的初始化、準(zhǔn)備及處理所需要的詳細(xì)規(guī)定，說(shuō)明查詢的能力、方式以及所使用的命令和所要求的控制規(guī)定。

（五）出錯(cuò)處理和恢復(fù)

1．列出由軟件產(chǎn)生的出錯(cuò)編碼或條件以及應(yīng)由用戶承擔(dān)的修改糾正工作。

2．指出為了確保再啟動(dòng)和恢復(fù)的能力，用戶必須遵循的處理過(guò)程。

（六）終端操作

當(dāng)軟件是在多終端系統(tǒng)上工作時(shí)，應(yīng)編寫(xiě)本條，以說(shuō)明終端的配置安排、連接步驟、數(shù)據(jù)和參數(shù)輸入步驟以及控制規(guī)定，說(shuō)明通過(guò)終端操作進(jìn)行查詢、檢索、修改數(shù)據(jù)文卷的能力、語(yǔ)言、過(guò)程以及輔助性程序等。

研發(fā)部

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

程序維護(hù)手冊(cè)（撰寫(xiě)指引）

一、引言

（一）編寫(xiě)目的

闡明編寫(xiě)手冊(cè)的目的，指明讀者對(duì)象。

（二）研發(fā)單位

說(shuō)明軟件研發(fā)項(xiàng)目的提出者、開(kāi)發(fā)者、用戶和使用場(chǎng)所。

（三）定義和縮寫(xiě)

列出報(bào)告中所用到的專門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的全稱。

（四）參考資料

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

二、系統(tǒng)說(shuō)明

（一）系統(tǒng)用途

說(shuō)明系統(tǒng)具備的功能、輸入和輸出。

（二）安全保密

說(shuō)明系統(tǒng)安全保密方面的考慮。

（三）總體說(shuō)明

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

（四）程序說(shuō)明

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

1．功能

2．方法

3．輸入

4．處理

（1）用圖表說(shuō)明程序中的運(yùn)行邏輯流程。

（2）程序主要轉(zhuǎn)移條件。

（3）對(duì)程序的約束條件。

（4）程序結(jié)束時(shí)的出口要求。

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

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

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

（8）輸出。

（9）接口。

（10）表格。

（11）特有的運(yùn)行性質(zhì)。

三、操作環(huán)境要求

（一）設(shè)備

（二）支持軟件

（三）數(shù)據(jù)庫(kù)

（四）標(biāo)識(shí)符

（五）數(shù)據(jù)庫(kù)的存儲(chǔ)媒體

四、維護(hù)過(guò)程

（一）規(guī)則

1．設(shè)計(jì)原則

（1）密切結(jié)合結(jié)構(gòu)（數(shù)據(jù)）設(shè)計(jì)和行為（處理）設(shè)計(jì)。

（2）有機(jī)結(jié)合硬件、軟件、技術(shù)和管理的界面。

（3）在具體程序?qū)崿F(xiàn)過(guò)程中，對(duì)記錄、字段的引用參照物。

（4）在設(shè)計(jì)過(guò)程中參照××程序設(shè)計(jì)方法。

2．設(shè)計(jì)程序變更的準(zhǔn)則

（1）檢查可供選擇的設(shè)計(jì)方案，尋找一種與程序的原始設(shè)計(jì)原理相容的變更設(shè)計(jì)。

（2）努力使設(shè)計(jì)簡(jiǎn)化。

（3）能滿足可變性要求。

（4）不降低程序質(zhì)量。

（5）用可測(cè)試并具備測(cè)試方法的術(shù)語(yǔ)描述設(shè)計(jì)。

（6）考慮處理時(shí)間、存儲(chǔ)量和操作過(guò)程方面的變化。

（7）考慮變更對(duì)用戶服務(wù)的干擾以及實(shí)施變更的代價(jià)和時(shí)間。

3．修改程序代碼的準(zhǔn)則

（1）必須要先熟悉整個(gè)程序的控制流程。

（2）不做不必要的修改。

（3）不影響原始程序的風(fēng)格和相容性。

（4）記錄所做過(guò)的修改。

（5）審查軟件質(zhì)量是否符合標(biāo)準(zhǔn)。

（6）更新程序文檔以反映修改并保留修改前的程序代碼版本。

4．重新驗(yàn)證程序的準(zhǔn)則

（1）首先測(cè)試程序故障，然后測(cè)試程序的未改動(dòng)部分，最后測(cè)試程序的修改部分。

（2）不允許做修改的維護(hù)程序員是惟一能夠重新驗(yàn)證程序的人。

（3）鼓勵(lì)終端用戶參與到重新測(cè)試進(jìn)程中來(lái)。

（4）在重新驗(yàn)證進(jìn)程中，記錄出錯(cuò)的次數(shù)與類型，并把結(jié)果同所提供的測(cè)試功能進(jìn)行比較，以便估量出程序是否退化。

（二）驗(yàn)證過(guò)程

每當(dāng)軟件被修改后，都要校驗(yàn)其正確性。維護(hù)人員應(yīng)該有選擇地做重新測(cè)試工作，不僅要證實(shí)新的邏輯的正確性，而且還要校驗(yàn)程序的未修改部分是否無(wú)損害，并且整個(gè)程序要運(yùn)行正確。若發(fā)現(xiàn)錯(cuò)誤，則要馬上進(jìn)行修正。

（三）出錯(cuò)及糾正方法

（四）專門(mén)維護(hù)過(guò)程

說(shuō)明文檔其他地方?jīng)]有提到的專門(mén)維護(hù)過(guò)程。

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

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

3．對(duì)閏年、世紀(jì)變更所需的臨時(shí)性修改等。

（五）專門(mén)維護(hù)程序

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

1．維護(hù)作業(yè)的輸入輸出要求。

2．輸入的詳細(xì)過(guò)程及在硬件設(shè)備上建立、運(yùn)行并完成維護(hù)作業(yè)的操作步驟。

五、程序清單及流程圖（略）

六、軟件研發(fā)總結(jié)報(bào)告

軟件研發(fā)總結(jié)報(bào)告（撰寫(xiě)指引）

一、引言

（一）編寫(xiě)目的

說(shuō)明編寫(xiě)這份項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告的目的，指出預(yù)期的閱讀范圍。

（二）背景說(shuō)明

1．本項(xiàng)目的名稱和所開(kāi)發(fā)出來(lái)的軟件系統(tǒng)的名稱。

2．此軟件的任務(wù)提出者、開(kāi)發(fā)者、用戶及安裝此軟件的計(jì)算中心。

（三）參考資料

列出要用到的參考資料，包括以下內(nèi)容。

1．本項(xiàng)目已核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同及上級(jí)機(jī)關(guān)的批文。

2．屬于本項(xiàng)目的其他已發(fā)表的文件。

3．本文件中各處所引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)，列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的路徑。

（四）說(shuō)明實(shí)際參加人員、時(shí)間及工作劃分

說(shuō)明參加本次研發(fā)工作的負(fù)責(zé)人、參加人員、起止時(shí)間及實(shí)際工作量。按研發(fā)的階段劃分，細(xì)化每位研發(fā)人員在各研發(fā)階段所用的研發(fā)時(shí)間及實(shí)際工作量。

二、研發(fā)結(jié)果

（一）產(chǎn)品說(shuō)明

說(shuō)明最終完成的產(chǎn)品，內(nèi)容包括以下四個(gè)方面。

1．程序系統(tǒng)中各個(gè)程序的名字及其之間的層次關(guān)系，以千字節(jié)為單位的各個(gè)程序的程序量、存儲(chǔ)形式和數(shù)量。

2．程序系統(tǒng)共有哪幾個(gè)版本，各自的版本號(hào)及各個(gè)版本之間的區(qū)別。

3．每個(gè)文件的名稱。

4．所建立的每個(gè)數(shù)據(jù)庫(kù)。如果研發(fā)中制訂過(guò)配置管理計(jì)劃，要同這個(gè)計(jì)劃相比較。

（二）主要功能和性能

1．逐項(xiàng)列出本軟件產(chǎn)品所實(shí)際具有的主要功能和性能。

2．對(duì)照可行性研究報(bào)告、項(xiàng)目開(kāi)發(fā)計(jì)劃、功能需求說(shuō)明書(shū)的有關(guān)內(nèi)容，說(shuō)明原定的研發(fā)目標(biāo)完成情況，指出差異并說(shuō)明原因。

（三）基本流程

用圖給出本程序系統(tǒng)實(shí)際、基本的處理流程。

（四）項(xiàng)目規(guī)?？偨Y(jié)

根據(jù)軟件研發(fā)的各個(gè)階段，總結(jié)該軟件產(chǎn)品完成的功能模塊數(shù)量與計(jì)劃的出入情況，給出對(duì)比圖表，并對(duì)比較結(jié)果進(jìn)行分析。

（五）項(xiàng)目人員總結(jié)

總結(jié)該軟件產(chǎn)品研發(fā)各個(gè)階段人員的變化情況與計(jì)劃的出入情況，并對(duì)比較結(jié)果進(jìn)行分析。

（六）進(jìn)度及工作量總結(jié)

總結(jié)實(shí)際完成軟件產(chǎn)品所用的時(shí)間及工作量與原計(jì)劃的出入情況。

（七）費(fèi)用控制總結(jié)

列出原定計(jì)劃費(fèi)用與實(shí)際支出費(fèi)用的對(duì)比情況。

1．工時(shí)，以“人/月”為單位，并按不同級(jí)別統(tǒng)計(jì)。

2．計(jì)算機(jī)的使用時(shí)間。

3．物料消耗、出差費(fèi)等其他費(fèi)用支出情況。

4．明確說(shuō)明費(fèi)用使用控制情況，并分析其主要原因。

三、研發(fā)工作評(píng)價(jià)

（一）對(duì)生產(chǎn)效率的評(píng)價(jià)

1．程序的平均生產(chǎn)效率，即每人每月生產(chǎn)的行數(shù)，以模塊為單位進(jìn)行比較。

2．文件的平均生產(chǎn)效率，即每人每月生產(chǎn)的千字?jǐn)?shù)。

3．列出原定計(jì)劃數(shù)，與實(shí)際情況進(jìn)行對(duì)比。

（二）對(duì)技術(shù)方法的評(píng)價(jià)

給出對(duì)在開(kāi)發(fā)中所使用的技術(shù)、方法、工具、手段的評(píng)價(jià)。

（三）對(duì)產(chǎn)品質(zhì)量的評(píng)價(jià)

說(shuō)明在測(cè)試中檢查出來(lái)的程序編制中的錯(cuò)誤發(fā)生率，如果開(kāi)發(fā)過(guò)程中制訂過(guò)質(zhì)量保證計(jì)劃，要同計(jì)劃相比較?？梢詮南旅嫖鍌€(gè)方面對(duì)產(chǎn)品質(zhì)量進(jìn)行評(píng)價(jià)。

1．歷次測(cè)試發(fā)現(xiàn)的Bug數(shù)。

2．同種原因產(chǎn)生的Bug數(shù)。

3．同種類型的Bug數(shù)。

4．各等級(jí)的Bug數(shù)。

5．同一Bug出現(xiàn)的次數(shù)。

（四）出錯(cuò)原因的分析

給出對(duì)于研發(fā)中出現(xiàn)的錯(cuò)誤的原因分析。

四、經(jīng)驗(yàn)與教訓(xùn)

列出從這項(xiàng)研發(fā)工作中所得到的最主要的經(jīng)驗(yàn)與教訓(xùn)及對(duì)今后項(xiàng)目開(kāi)發(fā)工作的建議?？蓮囊韵戮艂€(gè)方面總結(jié)研發(fā)中獲得的經(jīng)驗(yàn)與教訓(xùn)。

1．管理人員的管理水平。

2．研發(fā)人員的合理分工。

3．研發(fā)人員的技術(shù)水平。

4．研發(fā)人員的更換。

5．研發(fā)人員的配合及協(xié)作。

6．用戶的密切配合。

7．需求及設(shè)計(jì)的更改。

8．研發(fā)過(guò)程中計(jì)劃的合理調(diào)整。

9．其他。

#研發(fā)部##方案設(shè)計(jì)##管理工具#

本文由弗布克原創(chuàng)，版權(quán)歸屬弗布克，歡迎轉(zhuǎn)發(fā)，禁止轉(zhuǎn)載，抄襲、洗稿，侵權(quán)必究。

領(lǐng)取本資料的Word、PDF版完整內(nèi)容方法：

1.本資源編號(hào)：741。

2.關(guān)注 評(píng)論 轉(zhuǎn)發(fā)，然后私信“資料”。

更多相關(guān)資料可點(diǎn)擊下面“了解更多”。