概要設(shè)計說明書

目錄

1 簡介

1.1 目的

這部分要描述文檔的目的。應(yīng)該指明讀者。

1.2 范圍

1.2.1 軟件名稱

對軟件命名

1.2.2 軟件功能

解釋軟件產(chǎn)品將完成或不完成的功能（可以直接描述也可以參考相關(guān)文檔）

1.2.3 軟件應(yīng)用

描述軟件的應(yīng)用領(lǐng)域（可直接描述也可以參考其他軟件文檔）

2 第0層設(shè)計描述

2.1 軟件系統(tǒng)上下文定義

本節(jié)描述待開發(fā)軟件系統(tǒng)與外部實體的關(guān)系，可以使用系統(tǒng)結(jié)構(gòu)圖來描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系。

外部實體屬性描述只限于軟件設(shè)計和描述相關(guān)的屬性。考慮到描述的完整性，可參考相關(guān)軟件實體文檔，如OS程序員手冊。

2.2 設(shè)計思路(可選)

2.2.1 設(shè)計可選方案

對本軟件系統(tǒng)的幾種設(shè)計方案進(jìn)行分析、比較，并確定所采用的方案。

2.2.2 設(shè)計約束

1. 遵循標(biāo)準(zhǔn)

描述本軟件所遵循的標(biāo)準(zhǔn)、規(guī)范

2. 硬件限制

描述本軟件系統(tǒng)實現(xiàn)的硬件限制

3. 技術(shù)限制

描述本軟件的技術(shù)限制

2.2.3 其他

描述其他有關(guān)的設(shè)計考慮

3 第一層設(shè)計描述

3.1 系統(tǒng)結(jié)構(gòu)

如果本文檔是針對增強(qiáng)開發(fā)/小特性的設(shè)計，繼承了原有的系統(tǒng)結(jié)構(gòu)，那么應(yīng)拷貝原有的系統(tǒng)結(jié)構(gòu)說明，如系統(tǒng)結(jié)構(gòu)圖和相應(yīng)的文字說明，然后在一層設(shè)計中明顯標(biāo)識出新增功能在原有系統(tǒng)結(jié)構(gòu)中的位置（屬于原來哪一個模塊的新增功能，與原有各模塊之間有什么交互）。在后續(xù)的業(yè)務(wù)流程說明、模塊分解描述、依賴性描述和接口描述中，如果與本次增強(qiáng)開發(fā)/小特性無關(guān)的，可以不再重復(fù)描述，如果有關(guān)聯(lián)的，應(yīng)該拷貝原有的設(shè)計說明，在此基礎(chǔ)上再說明更改的內(nèi)容。

3.1.1 系統(tǒng)結(jié)構(gòu)描述

這里要描述軟件系統(tǒng)的總體結(jié)構(gòu)，可以使用結(jié)構(gòu)圖、層次分解圖或包圖來描述，并應(yīng)說明系統(tǒng)結(jié)構(gòu)劃分的原則（例如，基于標(biāo)準(zhǔn)、協(xié)議所規(guī)定的體系結(jié)構(gòu)，來自于分析模型的結(jié)果，或者基于原有體系結(jié)構(gòu)的結(jié)果）。對于使用分析模型的體系結(jié)構(gòu)，應(yīng)說明分析類的職責(zé)及相互關(guān)系。

3.1.2 業(yè)務(wù)流程說明

描述系統(tǒng)架構(gòu)模塊/分析類之間的動態(tài)交互，來說明用例模型中的典型用例場景，以體現(xiàn)系統(tǒng)功能是如何實現(xiàn)的。建議采用Sequence圖、Collaboration圖等來描述。

3.2 分解描述

本節(jié)描述系統(tǒng)中的子系統(tǒng)和模塊。

3.2.1 模塊/子系統(tǒng)1描述

不要直接寫“模塊/子系統(tǒng)1”，用簡短的詞語命名模塊/子系統(tǒng)。

按照以下格式描述：

1. 簡介

2. 功能列表

3.2.2 數(shù)據(jù)設(shè)計

本節(jié)描述系統(tǒng)中的數(shù)據(jù)結(jié)構(gòu)。

外部數(shù)據(jù)實體不必描述。

1. 數(shù)據(jù)實體1描述

按照以下格式描述：

標(biāo)識：

類型：

目的：

3.3 依賴性描述

本節(jié)描述系統(tǒng)中的子系統(tǒng)，數(shù)據(jù)結(jié)構(gòu)，模塊，進(jìn)程等設(shè)計實體間的關(guān)系。

依賴關(guān)系描述可以使用文字，結(jié)構(gòu)圖，（交互）事務(wù)圖。

3.4 接口描述

本節(jié)描述軟件系統(tǒng)中設(shè)計實體(如子系統(tǒng)，模塊，進(jìn)程）的接口.

I接口描述可以使用接口文件，參數(shù)表。

對于外部實體只有同被描述軟件相關(guān)的接口才需描述。

接口可以是函數(shù)調(diào)用、事件、消息、信號等。

3.4.1 模塊/子系統(tǒng)1的接口描述

對每個接口按照以下格式描述：

名稱：（接口名稱）

說明：（對接口的簡短說明）

定義:（接口原型定義，說明接口類型及相關(guān)參數(shù)）

4 第二層設(shè)計描述

L1中定義的每個模塊的進(jìn)一步設(shè)計在下面的章節(jié)進(jìn)行描述。對層次比較多的模塊，可以增加設(shè)計層次，最終要說明對應(yīng)于最小分解模塊的具體設(shè)計類（包括其public屬性和public方法）。

對每個模塊重復(fù)使用下述的格式。

4.1 模塊1名稱

不要直接寫 “模塊1名稱”，用簡短的詞語命名模塊。

如果本文檔是針對增強(qiáng)開發(fā)/小特性的設(shè)計，繼承了原有的二層模塊結(jié)構(gòu)，那么應(yīng)拷貝原有的模塊結(jié)構(gòu)說明，如包圖/類圖和相應(yīng)的文字說明，然后在二層設(shè)計中明顯標(biāo)識出新增功能在原有模塊結(jié)構(gòu)中的位置（屬于原來哪一個子模塊/設(shè)計類的新增功能，與原有各子模塊/設(shè)計類之間有什么交互）。在后續(xù)的功能實現(xiàn)說明和設(shè)計類定義中，如果與本次增強(qiáng)開發(fā)/小特性無關(guān)的，可以不描述，如果有關(guān)聯(lián)的，應(yīng)該拷貝原有的設(shè)計說明，在此基礎(chǔ)上再說明更改的內(nèi)容。 對更改的設(shè)計類應(yīng)該給出類的完整定義，再標(biāo)識出更改的屬性和方法。

4.1.1 模塊設(shè)計描述

描述模塊分解，例如每個子模塊的功能定義。定義出具體的設(shè)計類，用類圖來描述其相互關(guān)系，并說明所采用的設(shè)計模式。

對每個類重復(fù)使用下述的格式進(jìn)行描述。

1.類名

按下面的格式對每個設(shè)計類進(jìn)行說明。

1）CI標(biāo)識

說明該類的配置項標(biāo)識(用于需求跟蹤，配置項的命名方式在CMP中已定義。一般為：產(chǎn)品名_模塊名_類名，如果在類的命名中未包括前面兩部分)。

2）簡介

簡單介紹該類的功能。

3）類定義（Optional）

如果該類在前面沒有定義，使用類圖、偽代碼描述該類的類定義，需說明該類的所有public屬性和public方法。

4.1.2 功能實現(xiàn)說明

使用Sequence圖、Collaboration圖等來說明這些設(shè)計類之間如何交互，實現(xiàn)本模塊的典型功能。

5 數(shù)據(jù)庫設(shè)計（可選）

本節(jié)列出所有的數(shù)據(jù)存儲類的實體(表、存儲過程、觸發(fā)器等)，詳細(xì)描述實體的內(nèi)容和并列出全部屬性。對每個屬性，詳細(xì)描述其數(shù)據(jù)庫、數(shù)據(jù)大小、特定約束。實體的所有約束及實體間的關(guān)系也要注明。

5.1 實體定義

5.1.1 分解描述

闡述設(shè)計思路及約束規(guī)則。

詳細(xì)定義每個關(guān)鍵數(shù)據(jù)表、視圖中的各個字段屬性、存儲要求、完整性約束、功能、注意事項，靜態(tài)數(shù)據(jù)表可考慮定義初始配置記錄。

5.1.2 內(nèi)部依賴性描述

使用E-R圖描述實體間的關(guān)聯(lián)依賴關(guān)系，分析對存取空間、性能、完整性的要求。

5.2 行為定義

5.2.1 分解描述

根據(jù)功能或其他方式對存儲過程/觸發(fā)器進(jìn)行歸類，便于進(jìn)一步細(xì)化和分解，并說明每類存儲過程/觸發(fā)器主要功能。

詳細(xì)定義每個存儲過程(觸發(fā)器)的功能、輸入輸出參數(shù)、返回值、返回的記錄集、依賴的數(shù)據(jù)表和存儲過程，以及一些特殊要求（比如需要啟用事務(wù)等）。

5.2.2 外部依賴性描述

描述與其它模塊之間的依賴關(guān)系。

5.2.3 內(nèi)部依賴性描述

描述存儲過程間、存儲過程和數(shù)據(jù)表/視圖間依賴關(guān)系。

6 組件視圖

6.1 系統(tǒng)運(yùn)行組件

使用Component圖、deployment圖來描述系統(tǒng)的運(yùn)行組件（EXE文件、DLL等），及其網(wǎng)絡(luò)部署情況。

6.2 文件組織形式

描述源代碼文件的目錄結(jié)構(gòu)（文件夾中各個目錄下應(yīng)存放什么文件）。

7 進(jìn)程視圖

本節(jié)描述將系統(tǒng)分解為輕量級進(jìn)程（單個控制線程）和重量級進(jìn)程（成組的輕量級進(jìn)程）的過程。本節(jié)按照各個通信或交互的進(jìn)程組來加以組織。說明進(jìn)程之間的主要通信模式，例如消息傳遞、中斷和會合。

參考資料清單：

請羅列本文檔所參考的有關(guān)參考文獻(xiàn)和相關(guān)文檔，格式如下：

作者＋書名（或雜志、文獻(xiàn)、文檔）＋出版社（或期號、卷號、公司文檔編號）＋出版日期 起止頁碼。

例如：

[1] D. B. Leeson, “A Simple Model of Feedback Oscillator Noise Spectrum,” Proc. IEEE, pp329-330, February 1966 （英文文章格式）

[2] D. Wolaver, Phase-Locked Loop Circuit Design, Prentice Hall, New Jersey,1991 （英文書籍格式）

[3] 王陽元，奚雪梅等，“薄膜SOI/CMOS SPICE電路模擬”，電子學(xué)報，vol.22，No.5，1994 （中文文章格式）

[4] 鄭筠，《MOS存儲系統(tǒng)及技術(shù)》，科學(xué)出版社，1990 （中文書籍格式）

[5] XXX，SDXXX用戶手冊 V1.1，基礎(chǔ)部文檔室，2001/4/26

---

詳細(xì)設(shè)計模板

目錄

1 概述

1.1 目標(biāo)

應(yīng)包含以下幾個方面的內(nèi)容：

1、該文檔所描述的模塊；

2、該文檔所針對的讀者；

1.2 范圍

概述本文檔所包含的內(nèi)容

2 模塊1詳細(xì)設(shè)計

2.1 類1

2.1.1 簡介

詳細(xì)描述CLASS1的職責(zé)和功能；必要時，可描述本類與相關(guān)類之間的靜態(tài)/動態(tài)關(guān)系。

2.1.2 類圖

提供類的結(jié)構(gòu)圖

2.1.3 狀態(tài)設(shè)計

可用狀態(tài)圖來描述類的狀態(tài)信息

2.1.4 屬性

可先定義相關(guān)的數(shù)據(jù)結(jié)構(gòu)。.

可見性	屬性名稱	類型	說明（對屬性的簡短描述）

2.1.5 方法

下面針對每個方法進(jìn)行說明。

1. 方法1

（1）方法描述

Prototype	方法的聲明，包含可見性
函數(shù)原型
Description	描述本方法的功能
功能描述
Calls調(diào)用函數(shù)	被本函數(shù)調(diào)用的函數(shù)清單（非系統(tǒng)函數(shù)）
Called By被調(diào)用函數(shù)	調(diào)用本函數(shù)的函數(shù)清單（非系統(tǒng)函數(shù)）, 可選
Input輸入?yún)?shù)	描述每個輸入?yún)?shù)的含義、內(nèi)存管理原則
Output輸出參數(shù)	描述每個輸出參數(shù)的含義、內(nèi)存管理原則
Return返回值	描述返回值的含義
Exception拋出異常	描述可能拋出的異常

（2）Implementation Description實現(xiàn)描述

使用偽代碼、流程圖等來描述本方法的詳細(xì)實現(xiàn)。這部分是詳細(xì)設(shè)計的重點。

3 模塊2詳細(xì)設(shè)計

3.1 類1

3.1.1 簡介

詳細(xì)描述CLASS1的職責(zé)和功能；必要時，可描述本類與相關(guān)類之間的靜態(tài)/動態(tài)關(guān)系。

3.1.2 類圖

提供類的結(jié)構(gòu)圖

3.1.3 狀態(tài)設(shè)計

可用狀態(tài)圖來描述類的狀態(tài)信息

3.1.4 屬性

可先定義相關(guān)的數(shù)據(jù)結(jié)構(gòu)。.

可見性	屬性名稱	類型	說明（對屬性的簡短描述）

3.1.5 方法

下面針對每個方法進(jìn)行說明。

2. 方法1

（1）方法描述

Prototype	方法的聲明，包含可見性
函數(shù)原型
Description	描述本方法的功能
功能描述
Calls調(diào)用函數(shù)	被本函數(shù)調(diào)用的函數(shù)清單（非系統(tǒng)函數(shù)）
Called By被調(diào)用函數(shù)	調(diào)用本函數(shù)的函數(shù)清單（非系統(tǒng)函數(shù)）, 可選
Input輸入?yún)?shù)	描述每個輸入?yún)?shù)的含義、內(nèi)存管理原則
Output輸出參數(shù)	描述每個輸出參數(shù)的含義、內(nèi)存管理原則
Return返回值	描述返回值的含義
Exception拋出異常	描述可能拋出的異常

（2）Implementation Description實現(xiàn)描述

使用偽代碼、流程圖等來描述本方法的詳細(xì)實現(xiàn)。這部分是詳細(xì)設(shè)計的重點。

4 數(shù)據(jù)庫詳細(xì)設(shè)計(可選)

描述存儲過程、觸發(fā)器等的詳細(xì)實現(xiàn)

4.1 存儲過程1/觸發(fā)器1的名稱

（1）Descriptions語法

Prototype	原型描述
原型
Description	描述實現(xiàn)的功能
功能描述
使用的數(shù)據(jù)庫對象
Input輸入?yún)?shù)	描述每個輸入?yún)?shù)的含義
Output輸出參數(shù)	描述每個輸出參數(shù)的含義
Return返回值	描述返回值的含義

（2）Implementation Description實現(xiàn)描述

Pseudo codes could be used to depict the definitions.

使用偽代碼來描述詳細(xì)實現(xiàn)。這部分是詳細(xì)設(shè)計的重點。

5 錯誤處理

5.1 系統(tǒng)錯誤

描述象內(nèi)存分配失敗，任務(wù)創(chuàng)建失敗等錯誤是如何被處理的。

5.2 接口錯誤

描述將要產(chǎn)生并給外部實體用的錯誤碼

5.3 協(xié)議錯誤

描述在協(xié)議中沒有描述的情況如何處理。（可選）

---

軟件設(shè)計說明

目錄

1　范圍

1.1　標(biāo)識

本條應(yīng)描述本文檔所適用的系統(tǒng)、接口實體和接口的完整標(biāo)識，適用時，包括其標(biāo)識號、名稱、縮略名、版本號和發(fā)布號。

1.2　系統(tǒng)概述

本條應(yīng)概述本文檔所適用的系統(tǒng)和軟件的用途。它還應(yīng)描述系統(tǒng)與軟件的一般特性；概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識項目的需方、用戶、開發(fā)方和保障機(jī)構(gòu)等；標(biāo)識當(dāng)前和計劃的運(yùn)行現(xiàn)場；列出其他有關(guān)文檔。

1.3　文檔概述

本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與它的使用有關(guān)的保密性方面的要求。

2　引用文檔

本章應(yīng)列出引用文檔的編號、標(biāo)題、編寫單位、修訂版及日期，還應(yīng)標(biāo)識不能通過正常采購活動得到的文檔的來源。

3　CSCI級設(shè)計決策

本章應(yīng)根據(jù)需要分條給出CSCI級設(shè)計決策，即CSCI行為設(shè)計的決策（忽略其內(nèi)部實現(xiàn)，從用戶角度出發(fā)描述系統(tǒng)將怎樣運(yùn)轉(zhuǎn)以滿足需求）和其他影響組成該CSCI的軟件單元的選擇與設(shè)計的決策。如果在需求中所有這些決策是明確的，或者這些決策要推遲到CSCI的軟件單元的設(shè)計時指出，則本章應(yīng)如實陳述。針對關(guān)鍵性需求（例如對安全性或保密性關(guān)鍵的需求）作出的設(shè)計決策，應(yīng)在專門的章條申加以敘述。如果設(shè)計決策依賴于系統(tǒng)狀態(tài)或方式，則應(yīng)指明這一依賴性。本條應(yīng)給出或引用理解這些設(shè)計所需的設(shè)計約定。CSCI級設(shè)計決策的例子如下：

a) 關(guān)于CSCI將接收的輸入和將產(chǎn)生的輸出的設(shè)計決策，包括與其他系統(tǒng)、HWCI、CSCI和用戶的接口（本文檔的4.3.X條指出本說明要考慮的主題）。如果這一信息的全部或部分已在接口設(shè)計說明(IDD)中給出，則可以直接引用。

b) 有關(guān)響應(yīng)每個輸入或條件的CSCI行為的設(shè)計決策，包括CSCI要執(zhí)行的動作、響應(yīng)時間和其他性能特性，模型化的物理系統(tǒng)的說明，選定的方程式／算法／規(guī)則，以及對不允許的輸入或條件進(jìn)行的處理。

c) 有關(guān)數(shù)據(jù)庫，數(shù)據(jù)文件如何呈現(xiàn)給用戶的設(shè)計決策（本文檔的4.3.X條標(biāo)識了本說明要考慮的主題）。如果這一信息的全部或部分在數(shù)據(jù)庫設(shè)計說明(DBDD)中給出，則可直接引用。

d) 為滿足安全性和保密性需求所選擇的方法。

e) 為滿足需求所做的其他CSCI級設(shè)計決策，例如為提供所需的靈活性、可用性和可維護(hù)性所選擇的方法。

4　CSCI體系結(jié)構(gòu)設(shè)計

本章應(yīng)分為以下幾條描述CSCI體系結(jié)構(gòu)設(shè)計。如果設(shè)計的全部或部分依賴于系統(tǒng)的狀態(tài)或方式，此依賴性應(yīng)予指明。如果設(shè)計信息在多于一個條中出現(xiàn)，它只需被提供一次，而在其他條中引用。本條應(yīng)提供或引用為了理解設(shè)計所需要的設(shè)計約定。

4.1　CSCI部件

本條應(yīng)描述：

a) 構(gòu)成該CSCI的所有軟件單元。應(yīng)賦予每個軟件單元一個項目唯一的標(biāo)識符。

注：軟件單元是CSCI設(shè)計中的一個元素；例如，CSCI的一個主要分支、該主要分支的一個組成部分，一個類、對象、模塊、函數(shù)、例程或數(shù)據(jù)庫。軟件單元可以出現(xiàn)在層次結(jié)構(gòu)的不同層上，且又可以由其他軟件單元組成。在設(shè)計中，軟件單元與實現(xiàn)它們的代碼和數(shù)據(jù)實體（例程，過程，數(shù)據(jù)庫，數(shù)據(jù)文件等），或與包含這些實體的計算機(jī)文件之間，可以有、也可以沒有一對一的對應(yīng)關(guān)系。一個數(shù)據(jù)庫可被處理為一個CSCI也可被處理為一個軟件單元。SDD可以采用與所使用設(shè)計方法相一致的任何名字來稱呼軟件單元。

b) 軟件單元的靜態(tài)（如，由…組成）關(guān)系。根據(jù)所選擇的軟件設(shè)計方法學(xué)，可以給出多種關(guān)系（例如，采用面向?qū)ο蟮脑O(shè)計方法時，本條既可給出類和對象結(jié)構(gòu)，也可給出CSCI的模塊和過程結(jié)構(gòu)）。

) 每個軟件單元的用途，指明分配給它的CSCI需求和CSCI級設(shè)計決策(需求的分配也可在6a)中提供）。

d) 每個軟件單元的開發(fā)狀態(tài)／類型（如新開發(fā)、按原樣重用已有的設(shè)計或軟件、再工程的已有的設(shè)計或軟件、為重用而要開發(fā)的軟件等，為構(gòu)建版N計劃的軟件）。針對現(xiàn)有的設(shè)計或軟件，本說明應(yīng)提供標(biāo)識信息，例如名字、版本、文檔引用、庫等。

e)CSCI（若適用，針對每個軟件單元）計劃使用的計算機(jī)硬件資源（例如處理機(jī)能力，內(nèi)存能力，輸入／輸出設(shè)備能力，輔存能力以及通信／網(wǎng)絡(luò)設(shè)備能力）。本說明應(yīng)覆蓋CSCI的資源使用需求中、影響該CSCI的系統(tǒng)級資源分配中、以及在軟件開發(fā)計劃(SDP)的資源使用測量策劃中包含的全部計算機(jī)硬件資源。如果針對指定計算機(jī)硬件資源的所有使用數(shù)據(jù)都在同一處提供，例如在SDD中提供，那么本條可直接引用。對每個計算機(jī)硬件資源，應(yīng)包括如下信息：

1) 得到滿足的CSC[需求或系統(tǒng)級資源分配；

2) 使用數(shù)據(jù)基于的假設(shè)和條件（例如，典型用法、最壞情況用法、特定事件的假定）；

3) 影響使用的特殊考慮（例如，虛存、覆蓋、多處理器的使用情況，操作系統(tǒng)、庫軟件的開銷或其他實現(xiàn)開銷的影響）；

4) 所使用的測度的單位（例如，處理器能力的百分比、周期／秒、內(nèi)存字節(jié)數(shù)、千字節(jié)／ 秒）；

5) 進(jìn)行評估或測量酌級別（例如，軟件單元，CSCI或者可執(zhí)行程序）。

f) 標(biāo)識實現(xiàn)每個軟件單元的軟件放置在哪個程序庫中。

4.2　執(zhí)行方案

本條應(yīng)說明軟件單元間的執(zhí)行方案，可采用圖表和描述，來說明軟件單元間的動態(tài)關(guān)系，即CSCI運(yùn)行期間軟件單元間的相互作用情況，（若適用）應(yīng)包括執(zhí)行控制流程、數(shù)據(jù)流、動態(tài)控制序列、狀態(tài)轉(zhuǎn)換圖、時序圖、單元間的優(yōu)先關(guān)系、中斷處理、時序／排序關(guān)系、例外處理、并發(fā)執(zhí)行、

動態(tài)分配與去除分配、對象／進(jìn)程/任務(wù)的動態(tài)創(chuàng)建／刪除、以及動態(tài)行為的其他方面。

4.3　接口設(shè)計

4.3.1　接口標(biāo)識和接口圖

本條應(yīng)說明賦予每個接口的項目唯一的標(biāo)識符，（若適用）應(yīng)通過名稱、編號、版本及文檔引用來標(biāo)識接口實體（軟件單元、系統(tǒng)、配置項、用戶等）。該標(biāo)識應(yīng)說明哪些實體具有周定的接口特性（從而把接口需求分配給這些接口實體）；說明哪些實體正在開發(fā)或修改（這些實體已有各自的接口需求）。（若適用）應(yīng)通過接口圖來描述這些接口。

4.3.2　（接口的項目唯一的標(biāo)識符）

本條（從4.3.2開始）應(yīng)通過項目唯一的標(biāo)識符來標(biāo)識接口，應(yīng)簡要地標(biāo)識接口實體，根據(jù)需要可分條描述單方或雙方接口實體的特性。如果一指定的接口實體未包含在本SDD中（例如，一個外部系統(tǒng)），而描述接口實體需要提到其接口特性時，這些特性應(yīng)作為假設(shè)予以陳述、或以“當(dāng)[未涵蓋的實體]這樣做時，[所指定的實體]將……”的形式描述。本條可引用其他文檔（例如數(shù)據(jù)字典、協(xié)議標(biāo)準(zhǔn)、用戶接口標(biāo)準(zhǔn)）代替在此所描述的信息。本設(shè)計說明應(yīng)包括以下內(nèi)容（若適用），以任何適合于所提供的信息的順序提供，并應(yīng)從接口實體角度說明這些特性之間的區(qū)別（例如關(guān)于數(shù)據(jù)元素的大小、頻率或其他特性的不同期望值）：

a) 接口實體分配給接口的優(yōu)先級。

b) 要實現(xiàn)的接口類型（例如實時數(shù)據(jù)傳輸、數(shù)據(jù)的存儲和檢索等）。

c) 接口實體將提供、存儲、發(fā)送、訪問、接收的各個數(shù)據(jù)元素的特征，例如：

1) 名稱／標(biāo)識符：

a．項目唯一的標(biāo)識符；

b．非技術(shù)（自然語言）名稱；

c．?dāng)?shù)據(jù)元素名稱；

d．技術(shù)名稱（如在代碼或數(shù)據(jù)庫中的變量名或字段名）：

e．縮略名或同義名。

2) 教據(jù)類型（字母、數(shù)字、整數(shù)等）。

3) 大小與格式（如：字符串的長度和標(biāo)點符號）。

4) 計量單位（如：m等）。

5) 可能值的范圍或枚舉(如：0-99)。

6) 準(zhǔn)確性（正確程度）和精度（有效數(shù)位數(shù)）。

7)優(yōu)先級、定時、頻率、容量、序列以及其他約束條件（例如數(shù)據(jù)元素是否可以被更新、業(yè)務(wù)規(guī)則是否適用）。

8) 保密性約束。

9) 來源（建立／發(fā)送的實體）和接受者（使用／接收的實體）。

d) 接口實體將提供、存儲、發(fā)送、訪問、接收的數(shù)據(jù)元素組合體（記錄、消息、文件、數(shù)組、顯示、報表等）的特征，例如：

1) 名稱／標(biāo)識符：

a．項目唯一的標(biāo)識符； l

b．非技術(shù)（自然語言）名稱； ：

c．技術(shù)名稱（如在代碼或數(shù)據(jù)庫中的記錄名或數(shù)據(jù)結(jié)構(gòu)名）：

d．縮略名或同義名。

2) 數(shù)據(jù)元素組合體中的數(shù)據(jù)元素及其結(jié)構(gòu)（編號、順序和分組情況）。

3) 介質(zhì)（例如磁盤）以及介質(zhì)上數(shù)據(jù)元素／數(shù)據(jù)組合體的結(jié)構(gòu)。

4) 顯示和其他輸出的視聽特性（例如顏色、布局、字體、圖標(biāo)和其他顯示元素、峰嗚聲和亮度）。

5) 數(shù)據(jù)組合體之間的關(guān)系，如排序／存取特性。

6) 優(yōu)先級、定時、頻率、容量、序列及其他約束，例如數(shù)據(jù)組合體是否可被更新、業(yè)務(wù)規(guī)則是否適用。

7) 保密性約束。

8) 來源（建立，發(fā)送的實體）和接受者（使用接受的實體）。

e) 接口實體用于接口的通信方法的特征。如：

1) 項目唯一的標(biāo)識符；

2) 通信鏈接／帶寬／頻率／介質(zhì)及其特征；

3) 消息格式；

4) 流控制（如：序列編號和緩沖區(qū)分配）；

5) 數(shù)據(jù)傳輸率、周期或非周期、傳輸間隔；

6) 路由、尋址及命名約定；

7) 傳輸服務(wù)，包括：優(yōu)先級和等級：

8) 安全性／保密性考慮，如：加密、用戶鑒別、隔離和審核。

f) 接口實體用于接口的協(xié)議的特征，如：

1) 項目唯一的標(biāo)識符；

2) 協(xié)議的優(yōu)先級別／層次；

3) 打包，包括分段與重組、路由和尋址；

4) 合法性檢查、錯誤控制和恢復(fù)過程；

5) 同步，包括連接的建立、保持和終止；

6) 狀態(tài)、標(biāo)識和其他報告特性。

f) 其他特征，例如接口實體的物理兼容性（尺寸、公差、負(fù)荷、電壓和接插件的兼容性等）。

5　CSCI軟件詳細(xì)設(shè)計

5.1　X（軟件單元的項目唯一的標(biāo)識符，或者一組軟件單元的標(biāo)志符）

本條應(yīng)通過項目唯一的標(biāo)識符來標(biāo)識軟件單元，并對該單元進(jìn)行說明。（若適用）該說明應(yīng)包括下列信息。本條也可以指定一組軟件單元，然后再分小條對它們分別進(jìn)行標(biāo)識和說明，包含其他軟件單元的軟件單元可引用那些軟件單元的說明，而無需在此重復(fù)。

a) （若有）單元設(shè)計決策，例如所使用的算法[如果此前尚未選定）。

b) 該軟件單元設(shè)計中的任何約束、限定或非常規(guī)特征。

c) 如果使用的編程語言不同于該CSCI所指定的語言，則應(yīng)指出并說明使用它的理由。

d) 如果該軟件單元包含過程性命令或由過程性命令組成(例如數(shù)據(jù)庫管理系統(tǒng)(DBMS)中用于定義表單和報表的菜單選擇，用于數(shù)據(jù)庫訪問和操縱的在線DBMS查詢，用于代碼自動生成的圖形用戶接口(GUI)構(gòu)造器的輸入，操作系統(tǒng)的命令或Shell腳本），應(yīng)列出這些過程性命令，并引用解釋它們的用戶手冊或其他文檔。

e) 如果該軟件單元包含、接收或輸出數(shù)據(jù)，（若適用）應(yīng)對它的輸入、輸出及其他數(shù)據(jù)元素和數(shù)據(jù)元素組合體進(jìn)行說明。本文檔的4.3.X條提供了（若適用）應(yīng)包括的主題。軟件單元的局部數(shù)據(jù)應(yīng)與軟件單元的輸入或輸出數(shù)據(jù)分開來描述。如果該軟件單元是一個數(shù)據(jù)庫，應(yīng)引用相應(yīng)的數(shù)據(jù)庫設(shè)計說明(DBDD)：接口特性可以在這里提供、也可以引用第4章或相應(yīng)的接口設(shè)計說明(IDD)。

f) 如果該軟件單元包含邏輯，則給出該軟件單元所用到的邏輯，（若適用）應(yīng)包括：

1) 該軟件單元執(zhí)行啟動時，其內(nèi)部起作用的條件。

2) 將控制傳遞給其他軟件單元的條件。

3) 對每個輸入的響應(yīng)以及響應(yīng)時間，包括數(shù)據(jù)轉(zhuǎn)換、重命名以及數(shù)據(jù)傳輸操作。

4) 在軟件單元運(yùn)行期間的操作順序和動態(tài)控制序列，包括：

a．順序控制的方法；

b．該方法的邏輯和輸入條件，例如時序變異、優(yōu)先級分配等；

c．進(jìn)出內(nèi)存的數(shù)據(jù)傳輸；

d.對離散輸入信號的感知，以及該軟件單元內(nèi)中斷操作之間的時序關(guān)系。

6　需求的可追蹤性

本章應(yīng)包含：

a．從本SDD所標(biāo)識的每個軟件單元，到分配給他的CSCI需求的可追蹤性。

b．從每個CSCI需求，到分配這些需求的軟件單元的可追溯性。

7　注釋

本章應(yīng)包括有助于了解文檔的所有信息（例如：背景、術(shù)語、縮略語或公式）

---

軟件用戶手冊

目錄

1 范圍

1.1 標(biāo)識

a) 本文檔的標(biāo)題：；

b) 本文檔的標(biāo)識：；

c) 本文檔的版本號：；

d) 本文檔對應(yīng)的軟件名稱及版本：。

1.2 系統(tǒng)概述

注：本條應(yīng)概述本文檔所適用系統(tǒng)和軟件的用途。它還應(yīng)描述系統(tǒng)與軟件的一般特性;概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史;標(biāo)識項目的需方、用戶、開發(fā)方和保障機(jī)構(gòu)等;標(biāo)識當(dāng)前和計劃的運(yùn)行現(xiàn)場，列出其他有關(guān)文檔.

1.3 文檔概述

注：本節(jié)概述該文檔的用途和內(nèi)容，并描述與其使用有關(guān)的保密性或私密性要求。

2 引用文檔

注：本章應(yīng)列出引用文檔的編號、標(biāo)題、編寫單位、修訂版及日期

GJB 438B-2009 軍用軟件開發(fā)文檔通用要求

[AAA] 作者，《XXX書》，機(jī)構(gòu)名稱，日期

3 軟件綜述

3.1 軟件應(yīng)用

本條應(yīng)簡要說明軟件預(yù)期的用途，并應(yīng)描述對軟件使用所期望的能力、運(yùn)行改進(jìn)和受益情況。

3.2 軟件清單

系統(tǒng)運(yùn)行所提供軟件如表 31：

表 31軟件內(nèi)容清單

序號	文件名稱	版本號/發(fā)行號	備注
1	Windows XP	Windows XP 2002	出廠前安裝

3.3 軟件環(huán)境

本條應(yīng)描述用戶安裝并運(yùn)行該軟件所需的硬件、軟件、手工操作和其他的資源。(若適用)包括以下方面:

a) 應(yīng)提供的計算機(jī)設(shè)備，包括需要的內(nèi)存數(shù)量、輔存數(shù)量及外圍設(shè)備(如打印機(jī)和其他的輸入/輸出設(shè)備):

b) 應(yīng)提供的通信設(shè)備:

c) 應(yīng)提供的其他軟件，例如操作系統(tǒng)、數(shù)據(jù)庫、數(shù)據(jù)文件、實用程序和其他的支持系統(tǒng):

1) 應(yīng)提供的表格、規(guī)程或其他的手工操作:

2) 應(yīng)提供的其他設(shè)施、設(shè)備或資源。

3.4 軟件組織和操作概述

本條應(yīng)從用戶的角度出發(fā)，簡要描述軟件的組織與操作。(若適用)描述應(yīng)包括:

a) 從用戶的角度，概述軟件邏輯部件和每個部件的用途操作。

b) 用戶可能期望的性能特性，例如:

1) 可接受的輸入的類型、數(shù)量、速率:

2) 軟件產(chǎn)生的輸出類型、數(shù)量、準(zhǔn)確性和速率:

3) 典型的響應(yīng)時間和影響它的因素;

4) 典型的處理時間和影響它的因索;

5) 限制，例如可追蹤的事件數(shù)目:

6) 預(yù)期的錯誤率:

7) 預(yù)期的可靠性。

c) 該軟件執(zhí)行的功能與接口系統(tǒng)、組織或位置之間的關(guān)系。

d) 為管理軟件而能夠采取的監(jiān)控措施(例如口令〕

3.5 意外事故及運(yùn)行的備用狀態(tài)和方式

(若適用)本條應(yīng)說明在緊急時刻以及在不同運(yùn)行狀態(tài)和方式下用戶處理軟件的差異。

3.6 保密性

本條應(yīng)概述與本軟件相關(guān)的保密性考慮，適用時還應(yīng)包括對軟件或文檔進(jìn)行非授權(quán)復(fù)制的警告信息。

3.7 幫助和問題報告

本條應(yīng)標(biāo)識聯(lián)系方式、獲得幫助和報告軟件使用中遇到的問題所應(yīng)遵循的規(guī)程。

4 軟件入門

4.1 軟件的首次用戶

4.1.1 熟悉設(shè)備

4.1.2 訪問控制

在實際的應(yīng)用中，對綜合控制寬帶傳輸分系統(tǒng)的涉密要求比較嚴(yán)格，所以用戶在使用計算機(jī)時，管理員必須設(shè)置計算機(jī)的訪問密碼，并定期作出修改，以保證計算機(jī)信息的安全性。密碼修改方法具體操作方法如下：

4.1.3 安裝和設(shè)置

可參照章節(jié)3.3.3.1章節(jié)3.3.3.1的具體操作方法。

4.2 啟動

4.3 停止和掛起

5 使用指南

5.1 能力

5.2 約定

5.3 處理規(guī)程

5.3.1 軟件的使用

本條的標(biāo)題應(yīng)標(biāo)識出被描述的功能、菜單、事務(wù)或其他的過程。(若適用)本條應(yīng)描述并給出以以下方面的選項與實例，包括:菜單、圖標(biāo)、數(shù)據(jù)項表、用戶輸入、可能影響軟件與用戶的接口的其他軟硬件的輸入、輸出、診斷或錯誤消息、報警、以及能提供聯(lián)機(jī)描述或使用說明信息的幫助工具。給出的信息格式應(yīng)適合于軟件的特性。描述應(yīng)使用一致的風(fēng)格，例如對菜單的描述應(yīng)保持一致，對事務(wù)描述應(yīng)保持一致。

5.4 有關(guān)的處理

本條應(yīng)標(biāo)識并描述任何關(guān)于未被用戶直接調(diào)用，并且在5.3中也未描述的由軟件執(zhí)行的批處理、脫機(jī)處理或后臺處理，并應(yīng)說明支持這種處理的用戶的責(zé)任。

5.5 數(shù)據(jù)備份

本條應(yīng)描述創(chuàng)建和保留備份數(shù)據(jù)的規(guī)程，這些備份數(shù)據(jù)在發(fā)生錯誤、缺陷、誤動作或事故時可

以用來代替主要的數(shù)據(jù)拷貝。

5.6 錯誤、故障和緊急情況下的恢復(fù)

本條應(yīng)給出從發(fā)生錯誤或故障中重啟或恢復(fù)的詳細(xì)規(guī)程，以及確保緊急事件下運(yùn)行連續(xù)性的詳細(xì)規(guī)程。

5.6.1 錯誤信息列表

1) 創(chuàng)建數(shù)據(jù)庫失敗：可能原因為數(shù)據(jù)庫未安裝或者數(shù)據(jù)庫安裝時出現(xiàn)問題；

2) 通信服務(wù)器軟件無法運(yùn)行：可能原因沒有創(chuàng)建本軟件的數(shù)據(jù)庫；

3) 輸入的用戶名、密碼后不能進(jìn)入軟件界面：可能原因安裝數(shù)據(jù)庫時，沒有選擇gb2312編碼格式。

5.6.2 常見問題處理

5.6.3 數(shù)據(jù)恢復(fù)

5.7 消息

本條應(yīng)列出完成用戶功能時可能發(fā)生的所有錯誤消息、診斷消息等，或引用列出這些消息的附錄，并應(yīng)標(biāo)識和描述每一條消息的含義以及消息出現(xiàn)后要采取的動作。

5.8 快速參考指南

合適時，本條應(yīng)為使用該軟件提供或引用快速參考卡或頁。(若適用)快速參考指南應(yīng)概括常用的功能鍵、控制序列、格式、命令或軟件使用的其他方面。

6 注釋

注：本章應(yīng)包含有助于理解本文檔的一般信息（例如背景信息、詞匯表、原理）。本章應(yīng)包含為理解本文檔需要的術(shù)語和定義，所有縮略語和它們在文檔中的含義的字母序列表。