軟件開(kāi)發(fā)文檔說(shuō)明完整流程

在軟件行業(yè)有一句話(huà)：一個(gè)軟件能否順利的完畢并且功能是否完善，重要是看這個(gè)軟件有多少文檔，軟件開(kāi)發(fā)文檔是一個(gè)軟件的支柱，假如你的開(kāi)發(fā)文檔漏洞百出，那么你所開(kāi)發(fā)出來(lái)的軟件也不也許會(huì)好；開(kāi)發(fā)文檔的好壞可以直接影響到所開(kāi)發(fā)出來(lái)軟件的成功與否。

一、軟件開(kāi)發(fā)設(shè)計(jì)文檔：軟件開(kāi)發(fā)文檔涉及軟件需求說(shuō)明書(shū)、數(shù)據(jù)規(guī)定說(shuō)有書(shū)、概要設(shè)計(jì)說(shuō)明書(shū)、具體設(shè)計(jì)說(shuō)明書(shū)。1、軟件需求說(shuō)明書(shū)：也稱(chēng)為軟件規(guī)格說(shuō)明。該說(shuō)明書(shū)對(duì)所開(kāi)發(fā)軟件的功能、性能、用戶(hù)

界面及運(yùn)營(yíng)環(huán)境等做出具體的說(shuō)明。它是用戶(hù)與開(kāi)發(fā)人員雙方對(duì)軟件需求取得共同理

解基礎(chǔ)上達(dá)成的協(xié)議，也是實(shí)行開(kāi)發(fā)工作的基礎(chǔ)。軟件需求說(shuō)明書(shū)的編制目的的就是

為了使用戶(hù)和軟件開(kāi)發(fā)者雙方對(duì)該軟件的初始規(guī)定有一個(gè)共同的理解、并使之面成為

整個(gè)開(kāi)發(fā)工作的基礎(chǔ)。其格式規(guī)定如下：

1

引言

1．1

編寫(xiě)目的。1．2

背景

1．3

定義

2

任務(wù)概述

2．1

目的

2．2

用戶(hù)的特點(diǎn)

2．3

假定和約束

3

需求規(guī)定

3．1

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

3．2

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

3．2．1

精度

3．2．2

時(shí)間特性的需求

3．2．3

靈活性

3．3

輸入輸出規(guī)定

3．4

數(shù)據(jù)管理能力規(guī)定

3．5

故障解決規(guī)定

3．6

其他專(zhuān)門(mén)規(guī)定

4

運(yùn)營(yíng)環(huán)境規(guī)定

4．1

設(shè)備

4．2

支持軟件

4．3

接口

4．4

控制

2、概要設(shè)計(jì)說(shuō)明書(shū)：又稱(chēng)系統(tǒng)設(shè)計(jì)說(shuō)明書(shū)，這里所說(shuō)的系統(tǒng)是指程序系統(tǒng)。編制的目的是說(shuō)明對(duì)程序系統(tǒng)的設(shè)計(jì)考慮，涉及程序系統(tǒng)的基本解決。流程、程序系統(tǒng)的組織

結(jié)構(gòu)、模塊劃分、功能分派、接口設(shè)計(jì)。運(yùn)河行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和犯錯(cuò)解決設(shè)計(jì)等，為程序的具體設(shè)計(jì)提供基礎(chǔ)。其格式規(guī)定如下：

1

引言

1．1

編寫(xiě)目的

1．2

背景

1．3

定義

1．4

參考資料

2

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

2．1

需求規(guī)定

2．2

運(yùn)營(yíng)環(huán)境

2．3

基本設(shè)計(jì)概念和解決流程

2．4

結(jié)構(gòu)

2．5

功能需求與程序的關(guān)系

2．6

人工解決過(guò)程

2．7

尚未解決的問(wèn)題

3

接口設(shè)計(jì)

3．1

用戶(hù)接口

3．2

外部接口

3.。3

內(nèi)部接口

4

運(yùn)營(yíng)設(shè)計(jì)

4．1

運(yùn)營(yíng)模塊的組合

4．2

運(yùn)營(yíng)控制

4．3

運(yùn)營(yíng)時(shí)間

5

系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)

5．1

邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)

5．2

物理結(jié)構(gòu)設(shè)計(jì)規(guī)定

5．3

數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系

6

系統(tǒng)犯錯(cuò)解決設(shè)計(jì)

6．1

犯錯(cuò)信息

6．2

補(bǔ)救措施

6．3

系統(tǒng)維護(hù)設(shè)計(jì)。

3.具體設(shè)計(jì)文檔：重要是把我們每個(gè)小模塊，小功能的業(yè)務(wù)邏輯解決用文字的方式表達(dá)出來(lái)，讓程序員在編碼的時(shí)候有一個(gè)依據(jù)和參照；同時(shí)，在進(jìn)行具體文檔設(shè)計(jì)的時(shí)候，有的軟件公司也會(huì)根據(jù)不同的項(xiàng)目作出相應(yīng)的《軟件開(kāi)發(fā)代碼規(guī)范》性文檔，以保障我們所做工作的統(tǒng)一性。假如一個(gè)軟件系比較簡(jiǎn)樸，層次很少，本文獻(xiàn)可以不單獨(dú)編寫(xiě)，有關(guān)內(nèi)容合并入概要設(shè)計(jì)說(shuō)明書(shū)。其格式規(guī)定如下：

1

引言

1．1

編寫(xiě)目的

1．2

背景

1．3

定義

1．4

參考資料

2

程序設(shè)計(jì)系統(tǒng)的結(jié)構(gòu)

3

程序

1設(shè)計(jì)說(shuō)明

3．1

程序描述

3．2

功能

3．3

性能

3．4

輸入項(xiàng)

3．5

輸出項(xiàng)

3．6

算法

3．7

流程邏輯

3．8

接口

3．9

存儲(chǔ)分派

3．10

注釋設(shè)計(jì)

3．11

限制條件

3．12

測(cè)試計(jì)劃

3．13

尚未解決的問(wèn)題

4

程序

2設(shè)計(jì)說(shuō)明

...

二、軟件開(kāi)發(fā)管理文檔：可行性研究報(bào)告、項(xiàng)目開(kāi)發(fā)計(jì)劃、開(kāi)發(fā)進(jìn)度月報(bào)、項(xiàng)目開(kāi)發(fā)總結(jié)、模塊開(kāi)發(fā)卷宗。1.可行性研究報(bào)告：編寫(xiě)目的是，說(shuō)明該軟件開(kāi)發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)、經(jīng)濟(jì)和社會(huì)條件方面的可行性：評(píng)述為了合理達(dá)成開(kāi)發(fā)目的而也許選擇的各種方案；說(shuō)明并論證所選定的方案。其格式規(guī)定如下：

1

引言

1．1

編寫(xiě)目的

1．2

背景

1．3

定義

1．4

參考資料

2

可行性研究的前提

2．1

規(guī)定

2．2

目的

2．3

條件、假定和限制

2．4

進(jìn)行可行性研究的方法

2．5

評(píng)價(jià)尺度3

對(duì)現(xiàn)有系統(tǒng)的分析

3．1

解決流程和數(shù)據(jù)流程

3．2

工作負(fù)荷

3．3

費(fèi)用開(kāi)支

3．4

人員

3．5

設(shè)備3．6

局限性

4

所建議的系統(tǒng)

4．1

對(duì)所建議系統(tǒng)的說(shuō)明

4．2

解決流程和數(shù)據(jù)流程

4．3

改善之處

4．4

影響

4．4．1

結(jié)設(shè)備的影響

4．4．2

對(duì)軟件的影響

4．4．3

對(duì)用戶(hù)單位機(jī)構(gòu)的影響

4．4．4

對(duì)系統(tǒng)運(yùn)營(yíng)過(guò)程的影響

4．4．5

對(duì)開(kāi)發(fā)的影響4．4．6

對(duì)地點(diǎn)和設(shè)備的影響

4．4．7

對(duì)經(jīng)費(fèi)開(kāi)支的影響

4．5

局限性

4．6

技術(shù)條件方面的可行性

5

可選擇的其他系統(tǒng)的可行性

5．1

可選擇的系統(tǒng)方案1

5．2

可選擇的系統(tǒng)方案2

6

投資及效益分析

6．1

支出

6．1．1

基本建設(shè)投資

6．1．2

其他一次性支出

6．1．3

非一次性支出

6．2

收益

6．2．1

一次性收益

6．2．2

非一次性收益

6．2．3

不可定量的收益

6．3

收益投資比

6．4

投資回收周期

6．5

敏感性分析

7

社會(huì)因素方面的可行性

7．1

法律方面的可行性

7．2

使用方面的可行性

8

結(jié)論

2.項(xiàng)目開(kāi)發(fā)計(jì)劃：是為軟件項(xiàng)目實(shí)行方案制定出的具體計(jì)劃。項(xiàng)目開(kāi)發(fā)計(jì)劃應(yīng)提前給管理部門(mén)，并作為開(kāi)發(fā)階段評(píng)審的基礎(chǔ)。編制項(xiàng)目開(kāi)發(fā)計(jì)劃的止的是用文獻(xiàn)的形式，把對(duì)于在開(kāi)發(fā)過(guò)程中各項(xiàng)工作的負(fù)責(zé)人員、開(kāi)發(fā)進(jìn)度、所需經(jīng)費(fèi)預(yù)算、所需的軟硬條件等問(wèn)題做出的安排記載下來(lái)，以便根據(jù)本計(jì)劃開(kāi)展和檢查項(xiàng)目的開(kāi)發(fā)工作。其格式規(guī)定如下：

1

引言

1．1

編寫(xiě)目的

1．2

定義

1．3

參考資料

2

項(xiàng)目概述

2．1

工作內(nèi)容

2．2

重要參與人員

2．3

產(chǎn)品

2．3．1

程序

2．3．2

方件

2．3．3

服務(wù)

2．3．4

非移交的產(chǎn)品

2．4

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

2．5

完畢項(xiàng)目的最遲期限

2．6

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

3

實(shí)行計(jì)劃

3．1

工作任務(wù)的分派與人員分工

3．2

接口人員

3．3

進(jìn)度

3．4

預(yù)算

3．5

關(guān)鍵問(wèn)題

4

支持條件

4．1

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

4．2

需收用戶(hù)承擔(dān)的工作

4．3

由外單位提供的條件

5

專(zhuān)題計(jì)劃要點(diǎn)

3.開(kāi)發(fā)進(jìn)度月報(bào)：開(kāi)發(fā)進(jìn)度月報(bào)的編制目的是及時(shí)向有關(guān)部門(mén)報(bào)告項(xiàng)目開(kāi)發(fā)的進(jìn)度和情況，以便及時(shí)

發(fā)現(xiàn)和解決開(kāi)發(fā)過(guò)程中出現(xiàn)的問(wèn)題，一般開(kāi)發(fā)進(jìn)度月報(bào)是以項(xiàng)目組單位每月編寫(xiě)的。假如被開(kāi)發(fā)的軟件系統(tǒng)規(guī)模比較大，整個(gè)工程項(xiàng)目被劃分給若干個(gè)分項(xiàng)目駔承擔(dān)，開(kāi)發(fā)進(jìn)度月報(bào)將以分項(xiàng)目為單位摟月編寫(xiě)。其格式規(guī)定如下：

1

標(biāo)題

2

工程進(jìn)度與狀態(tài)

2．1

進(jìn)度

2．2

狀態(tài)

3

資源耗用與狀態(tài)

3．1

資源耗用

3．1．1

工時(shí)

3．1．3

機(jī)時(shí)

3．2

狀態(tài)

4

經(jīng)費(fèi)支出與狀態(tài)

4．1

經(jīng)費(fèi)支出

4．1．1

支持性費(fèi)用

4．1．2

設(shè)備購(gòu)置費(fèi)

4．2

狀態(tài)

5

下一個(gè)月的工作計(jì)劃

6

建議

4.項(xiàng)目開(kāi)發(fā)總結(jié)：軟件項(xiàng)目開(kāi)發(fā)完畢之后，應(yīng)當(dāng)與項(xiàng)目實(shí)行計(jì)劃對(duì)照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)度、

成果、資源運(yùn)用、成本和投入的人力。此外，還需對(duì)開(kāi)發(fā)工作做出評(píng)價(jià)，總結(jié)經(jīng)驗(yàn)和教訓(xùn)。項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告的編制是為了總結(jié)本項(xiàng)目開(kāi)發(fā)工作的經(jīng)驗(yàn)，說(shuō)明實(shí)際取得的開(kāi)發(fā)結(jié)果以及對(duì)整個(gè)開(kāi)發(fā)工作的各個(gè)方面的評(píng)價(jià)。其格式規(guī)定如下：

1

引言

1．1

編寫(xiě)目的

1．2

背景

1．3

定義

1．4

參考資料

2

實(shí)際開(kāi)以結(jié)果

2．1

產(chǎn)品

2．2

重要功能和性能

2．3

基本流程

2．4

進(jìn)度

2．5

費(fèi)用

3

開(kāi)發(fā)工作評(píng)價(jià)

3．1

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

3．2

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

3．3

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

3．4

犯錯(cuò)因素的分析

4

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

5.模塊開(kāi)發(fā)卷宗：模塊開(kāi)發(fā)卷宗是在模塊開(kāi)發(fā)過(guò)程中逐步編寫(xiě)出來(lái)的，每完畢一個(gè)模塊或一組密切相關(guān)的模塊的復(fù)制進(jìn)編寫(xiě)一份，應(yīng)當(dāng)把所有的模塊開(kāi)發(fā)卷宗匯集在一起。編寫(xiě)的目的是記錄和匯意低層次開(kāi)發(fā)的進(jìn)度和結(jié)果，經(jīng)便于對(duì)整個(gè)模塊開(kāi)發(fā)工作的管理和復(fù)審，并為將來(lái)的維護(hù)提供非常有用的技術(shù)信息。1

標(biāo)題

2

模塊開(kāi)發(fā)情況表：其中模塊開(kāi)發(fā)情況表的格式如下表：模塊標(biāo)記符模塊的描述性名稱(chēng)代碼設(shè)計(jì)（計(jì)劃開(kāi)始日期

實(shí)際開(kāi)始日期）模塊測(cè)試（計(jì)劃開(kāi)始日期

實(shí)際開(kāi)始日期）組裝測(cè)試（計(jì)劃開(kāi)始日期

實(shí)際開(kāi)始日期）代碼復(fù)查(日期/簽字)源代碼行數(shù)（預(yù)計(jì)/實(shí)際）目際模塊大?。A(yù)計(jì)

實(shí)際）項(xiàng)目負(fù)責(zé)人批準(zhǔn)(日期/簽字)3

功能說(shuō)明

4

設(shè)計(jì)說(shuō)明

5

源代碼清單

6

測(cè)試說(shuō)明

7

復(fù)審的結(jié)論

三、軟件開(kāi)發(fā)測(cè)試文檔：概要測(cè)試計(jì)劃、具體測(cè)試計(jì)劃、測(cè)試實(shí)行計(jì)劃、測(cè)試分析報(bào)告。1.概要測(cè)試計(jì)劃：是軟件項(xiàng)目實(shí)行計(jì)劃中的一項(xiàng)重要的內(nèi)容，應(yīng)當(dāng)在軟件開(kāi)發(fā)初期、即需求分析階段制訂。項(xiàng)計(jì)劃應(yīng)當(dāng)定義被測(cè)試對(duì)象和測(cè)試目的，擬定測(cè)試階段和測(cè)試周期的劃分；制訂測(cè)

試人員、軟硬件資源和測(cè)試進(jìn)度等方面的計(jì)劃，規(guī)定軟件測(cè)試方法，測(cè)試標(biāo)準(zhǔn)以及支持環(huán)境和測(cè)試工具。2.具體測(cè)試計(jì)劃：是針對(duì)子系統(tǒng)在特定的測(cè)試階段所要進(jìn)行的測(cè)試工作制訂具體計(jì)劃，它具體說(shuō)明規(guī)定了測(cè)試小組的各項(xiàng)測(cè)試任務(wù)，測(cè)試策略、任務(wù)分派和進(jìn)度安排等。3.測(cè)試實(shí)行計(jì)劃：測(cè)試人員的測(cè)試實(shí)行計(jì)劃是根據(jù)具體計(jì)劃制訂的測(cè)試者的測(cè)試具體實(shí)行計(jì)劃。它規(guī)定了測(cè)試者在每一輪測(cè)試中負(fù)責(zé)測(cè)試的內(nèi)容，測(cè)試強(qiáng)度和工作進(jìn)度等。測(cè)試實(shí)行計(jì)劃是整個(gè)軟件測(cè)試的組成部分，是檢查測(cè)試實(shí)際執(zhí)行情況的重要依據(jù)。其格式規(guī)定如下：

1

引言

1．1

編寫(xiě)目的

1．2

背景

1．3

定義

1．4

參考資料

2

計(jì)劃

2．1

軟件說(shuō)明

2．2

測(cè)試內(nèi)容

2．3

測(cè)試2．3．1

進(jìn)度安排

2．3．2

條件

2．3．3

測(cè)試資料

2．3．4

測(cè)試培訓(xùn)

2．4

測(cè)試

3

測(cè)試設(shè)計(jì)說(shuō)明

3．1

測(cè)試

3．1．1

控制

3．1．2

輸入

3．1．3

輸出

3．1．4

過(guò)程

3．2

測(cè)試

4

評(píng)價(jià)準(zhǔn)則

4．1

范圍

4．2

數(shù)據(jù)整理

4．3

尺度

4.測(cè)試分析報(bào)告：測(cè)試工作完畢以后，應(yīng)當(dāng)提交測(cè)試計(jì)劃情況說(shuō)明書(shū)，對(duì)測(cè)試結(jié)果加以分析，并提

出測(cè)試的結(jié)論性意見(jiàn)。其格式規(guī)定如下：

1

引言

1．1

編寫(xiě)目的

1．2

背景

1．3

定義

1．4

參考資料

2

測(cè)試概要

3

測(cè)試結(jié)果及發(fā)現(xiàn)

3．1

測(cè)試

13．2

測(cè)試

2

4

對(duì)軟件功能的結(jié)論

4．1

功能

1

4．1．1

能力

4．1．2

限制4．2

功能

25

分析摘要

5．1

能力

5．2

缺陷和限制

5．3

建議

5．4

評(píng)價(jià)

6

測(cè)試資源消耗四、用戶(hù)文檔：用戶(hù)手冊(cè)、操作手冊(cè)。1.用戶(hù)手冊(cè)：用戶(hù)手冊(cè)的編制是要使用非專(zhuān)門(mén)術(shù)語(yǔ)的語(yǔ)言，充足地描述該軟件系統(tǒng)所具有的功能及基本的使用方法，使用戶(hù)（或潛在用戶(hù)）通過(guò)本手冊(cè)可以了解該軟件的用途，并且可以擬定在什么情況下，如何使用它。其格式規(guī)定如下：

1

引言

1．1

編寫(xiě)目的

1．2

背景

1．3

定義

1．4

參考資料

2

用途

2．1

功能

2．2

性能

2．2．1

精度

2．2．2

時(shí)間特性

2．2．3

靈活性

2．3

安全保密

3

運(yùn)營(yíng)環(huán)境

3．1

硬設(shè)備

3．2

支持軟件

3．3

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

4

使用過(guò)程

4．1

安裝與初始化

4．2

輸入

4．2．1

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

4．2．2

輸入格式

4．2．3

輸入舉例

4．3

輸出

4．3．1

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

4．3．2

輸出格式

4．3．3

輸出舉例

4．4

文卷查詢(xún)

4．5

犯錯(cuò)解決和恢復(fù)

4．6

終端操作

2.操作手冊(cè)：操作手冊(cè)的編制是為了向操作人員提供該軟件每一個(gè)運(yùn)營(yíng)的具體過(guò)程和有關(guān)知識(shí)，涉及操作方法的細(xì)節(jié)。其格式規(guī)定如下：1

引言

1．1

編寫(xiě)目的

1．2

背景

1．3

定義

1．4

參考資料

2

軟件征述

2．1

軟件的結(jié)構(gòu)

2．2

程序表

2．3

文卷表

3

安裝與初始化

4

運(yùn)營(yíng)說(shuō)明

4．1

運(yùn)營(yíng)表

4．2

運(yùn)營(yíng)環(huán)節(jié)

4．3

運(yùn)營(yíng)

14．3．1

運(yùn)營(yíng)控制

4．3．2

操作控制

4．3．3

輸入輸出文卷

4．3．4

輸出文段

4．3．5

輸出文段的復(fù)制4．3．6

恢復(fù)過(guò)程

4．4

運(yùn)營(yíng)

2

...5

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

6

遠(yuǎn)程操作

3.維護(hù)建議：軟件產(chǎn)品投入運(yùn)營(yíng)之后，也許有修改、更正等問(wèn)題。應(yīng)當(dāng)對(duì)存在的問(wèn)題、修改的考慮以及修改的影響估計(jì)等作具體