軟件工程文檔標(biāo)準(zhǔn)

軟件工程文檔標(biāo)準(zhǔn)

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

概要設(shè)計(jì)說(shuō)明書(shū)又可稱系統(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ì)等，為程序的詳細(xì)設(shè)計(jì)提供基礎(chǔ)。編制概要設(shè)計(jì)說(shuō)明書(shū)的內(nèi)容

要求如下：

11．1引言

11.1．

1編寫目的

11．1．2背景

11．1．3定義

11.1．4參考資料

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

11.2.1需求規(guī)定

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

11．2．3基本設(shè)計(jì)概念和處理流程

11．

2．

4”結(jié)構(gòu)

11．2．5功能需求與程序的關(guān)系

11．

2．

6人工處理過(guò)程

11．2．7尚未解決的問(wèn)題

11．3接口設(shè)計(jì)

11．31用戶接口

11．32外部接口

11．3

3內(nèi)部接口

11．4運(yùn)行設(shè)計(jì)

11.

4.

1運(yùn)行模塊組合

11.4.2運(yùn)行控制

11.4.3運(yùn)行時(shí)間

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

11.

5.

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

11.

5.

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

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

11．

6系統(tǒng)出錯(cuò)處理設(shè)計(jì)

11.

6.

1出錯(cuò)信息

11.6．2補(bǔ)救措施

11.6

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

附錄E

概要設(shè)計(jì)說(shuō)明書(shū)的編寫提示

（參考件）

E.1引言

E.1.1編寫目的

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

E.1.2背景

說(shuō)明：

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

b．列出此項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶以及將運(yùn)行該軟件的計(jì)算站（中心）。

E.1．3定義

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

E.1.4參考資料

列出有關(guān)的參考文件，如：

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

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

c．本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。

列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的來(lái)源。

E.2總體設(shè)計(jì)

E.2.1需求規(guī)定

說(shuō)明對(duì)本系統(tǒng)的主要的輸入輸出項(xiàng)目、處理的功能性能要求，詳細(xì)的說(shuō)明可參見(jiàn)附錄C。

E.2.2運(yùn)行環(huán)境

簡(jiǎn)要地說(shuō)明對(duì)本系統(tǒng)的運(yùn)行環(huán)境（包括硬件環(huán)境和支持環(huán)境）的規(guī)定，詳細(xì)說(shuō)明參見(jiàn)附錄C。

E．2．3基本設(shè)計(jì)概念和處理流程

說(shuō)明本系統(tǒng)的基本設(shè)計(jì)概念和處理流程，盡量使用圖表的形式。

E.2.4結(jié)構(gòu)

用一覽表及框圖的形式說(shuō)明本系統(tǒng)的系統(tǒng)元素（各層模塊、子程序、公用程序等）的劃分，扼要說(shuō)明每個(gè)系統(tǒng)元素的標(biāo)識(shí)符和功能，分層次地給出各元素之間的控制與被控制關(guān)系.

E.2.5功能器求與程序的關(guān)系

本條用一張如下的矩陣圖說(shuō)明各項(xiàng)功能需求的實(shí)現(xiàn)同各塊程序的分配關(guān)系：

E．2．6人工處理過(guò)程

說(shuō)明在本軟件系統(tǒng)的工作過(guò)程中不得不包含的人工處理過(guò)程（如果有的話）。

E.2.7尚未問(wèn)決的問(wèn)題

說(shuō)明在概要設(shè)計(jì)過(guò)程中尚未解決而設(shè)計(jì)者認(rèn)為在系統(tǒng)完成之前必須解決的各個(gè)問(wèn)題。

E．3

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

E．3．1用戶接口

說(shuō)明將向用戶提供的命令和它們的語(yǔ)法結(jié)構(gòu)，以及軟件的回答信息。

E．3.2外部接口

說(shuō)明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持軟件之間的接

口關(guān)系。

E．3．3內(nèi)部接口

說(shuō)明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)元素之間的接口的安排。

E．4運(yùn)行設(shè)計(jì)

E．4．1運(yùn)行模塊組合

說(shuō)明對(duì)系統(tǒng)施加不同的外界運(yùn)行控制時(shí)所引起的各種不同的運(yùn)行模塊組合，說(shuō)明每種運(yùn)行所歷經(jīng)的內(nèi)部模塊和支持軟件。

E．4．2運(yùn)行控制

說(shuō)明每一種外界的運(yùn)行控制的方式方法和操作步驟。

E．4．3運(yùn)行時(shí)間

說(shuō)明每種運(yùn)行模塊組合將占用各種資源的時(shí)間。

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

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

給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)的名稱、標(biāo)識(shí)符以及它們之中每個(gè)數(shù)據(jù)項(xiàng)、記錄、文卷和系的標(biāo)識(shí)、定義、長(zhǎng)度及它們之間的層次的或表格的相互關(guān)系。

E.5．2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)

給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲(chǔ)要求，訪問(wèn)方法、存取單位、存取的物理關(guān)系（索引、設(shè)備、存儲(chǔ)區(qū)域）、設(shè)計(jì)考慮和保密條件。

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

說(shuō)明各個(gè)數(shù)據(jù)結(jié)構(gòu)與訪問(wèn)這些數(shù)據(jù)結(jié)構(gòu)的形式:

E.6系統(tǒng)出錯(cuò)處理設(shè)計(jì)

E.6.1出錯(cuò)信息

用一覽表的方式說(shuō)朗每種可能的出錯(cuò)或故障情況出現(xiàn)時(shí)，系統(tǒng)輸出信息的形式、含意及處理方法。

E.6.2補(bǔ)救措施

說(shuō)明故障出現(xiàn)后可能采取的變通措施，包括：

a.后備技術(shù)說(shuō)明準(zhǔn)備采用的后備技術(shù)，當(dāng)原始系統(tǒng)數(shù)據(jù)萬(wàn)一丟失時(shí)啟用的副本的建立和啟動(dòng)的技術(shù)，例如周期性地把磁盤信息記錄到磁帶上去就是對(duì)于磁盤媒體的一種后備技術(shù)；

b．降效技術(shù)說(shuō)明準(zhǔn)備采用的后備技術(shù)，使用另一個(gè)效率稍低的系統(tǒng)或方法來(lái)求得所需結(jié)果的某些部分，例如一個(gè)自動(dòng)系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄；

c．恢復(fù)及再啟動(dòng)技術(shù)說(shuō)明將使用的恢復(fù)再啟動(dòng)技術(shù)，使軟件