概要設計說明書

目錄

1 簡介

1.1 目的

這部分要描述文檔的目的。應該指明讀者。

1.2 范圍

1.2.1 軟件名稱

對軟件命名

1.2.2 軟件功能

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

1.2.3 軟件應用

描述軟件的應用領域（可直接描述也可以參考其他軟件文檔）

2 第0層設計描述

2.1 軟件系統上下文定義

本節描述待開發軟件系統與外部實體的關系，可以使用系統結構圖來描述系統結構和交互關系。

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

2.2 設計思路(可選)

2.2.1 設計可選方案

對本軟件系統的幾種設計方案進行分析、比較，并確定所采用的方案。

2.2.2 設計約束

1. 遵循標準

描述本軟件所遵循的標準、規范

2. 硬件限制

描述本軟件系統實現的硬件限制

3. 技術限制

描述本軟件的技術限制

2.2.3 其他

描述其他有關的設計考慮

3 第一層設計描述

3.1 系統結構

如果本文檔是針對增強開發/小特性的設計，繼承了原有的系統結構，那么應拷貝原有的系統結構說明，如系統結構圖和相應的文字說明，然后在一層設計中明顯標識出新增功能在原有系統結構中的位置（屬于原來哪一個模塊的新增功能，與原有各模塊之間有什么交互）。在后續的業務流程說明、模塊分解描述、依賴性描述和接口描述中，如果與本次增強開發/小特性無關的，可以不再重復描述，如果有關聯的，應該拷貝原有的設計說明，在此基礎上再說明更改的內容。

3.1.1 系統結構描述

這里要描述軟件系統的總體結構，可以使用結構圖、層次分解圖或包圖來描述，并應說明系統結構劃分的原則（例如，基于標準、協議所規定的體系結構，來自于分析模型的結果，或者基于原有體系結構的結果）。對于使用分析模型的體系結構，應說明分析類的職責及相互關系。

3.1.2 業務流程說明

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

3.2 分解描述

本節描述系統中的子系統和模塊。

3.2.1 模塊/子系統1描述

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

按照以下格式描述：

1. 簡介

2. 功能列表

3.2.2 數據設計

本節描述系統中的數據結構。

外部數據實體不必描述。

1. 數據實體1描述

按照以下格式描述：

標識：

類型：

目的：

3.3 依賴性描述

本節描述系統中的子系統，數據結構，模塊，進程等設計實體間的關系。

依賴關系描述可以使用文字，結構圖，（交互）事務圖。

3.4 接口描述

本節描述軟件系統中設計實體(如子系統，模塊，進程）的接口.

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

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

接口可以是函數調用、事件、消息、信號等。

3.4.1 模塊/子系統1的接口描述

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

名稱：（接口名稱）

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

定義:（接口原型定義，說明接口類型及相關參數）

4 第二層設計描述

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

對每個模塊重復使用下述的格式。

4.1 模塊1名稱

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

如果本文檔是針對增強開發/小特性的設計，繼承了原有的二層模塊結構，那么應拷貝原有的模塊結構說明，如包圖/類圖和相應的文字說明，然后在二層設計中明顯標識出新增功能在原有模塊結構中的位置（屬于原來哪一個子模塊/設計類的新增功能，與原有各子模塊/設計類之間有什么交互）。在后續的功能實現說明和設計類定義中，如果與本次增強開發/小特性無關的，可以不描述，如果有關聯的，應該拷貝原有的設計說明，在此基礎上再說明更改的內容。 對更改的設計類應該給出類的完整定義，再標識出更改的屬性和方法。

4.1.1 模塊設計描述

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

對每個類重復使用下述的格式進行描述。

1.類名

按下面的格式對每個設計類進行說明。

1）CI標識

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

2）簡介

簡單介紹該類的功能。

3）類定義（Optional）

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

4.1.2 功能實現說明

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

5 數據庫設計（可選）

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

5.1 實體定義

5.1.1 分解描述

闡述設計思路及約束規則。

詳細定義每個關鍵數據表、視圖中的各個字段屬性、存儲要求、完整性約束、功能、注意事項，靜態數據表可考慮定義初始配置記錄。

5.1.2 內部依賴性描述

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

5.2 行為定義

5.2.1 分解描述

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

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

5.2.2 外部依賴性描述

描述與其它模塊之間的依賴關系。

5.2.3 內部依賴性描述

描述存儲過程間、存儲過程和數據表/視圖間依賴關系。

6 組件視圖

6.1 系統運行組件

使用Component圖、deployment圖來描述系統的運行組件（EXE文件、DLL等），及其網絡部署情況。

6.2 文件組織形式

描述源代碼文件的目錄結構（文件夾中各個目錄下應存放什么文件）。

7 進程視圖

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

參考資料清單：

請羅列本文檔所參考的有關參考文獻和相關文檔，格式如下：

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

例如：

[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電路模擬”，電子學報，vol.22，No.5，1994 （中文文章格式）

[4] 鄭筠，《MOS存儲系統及技術》，科學出版社，1990 （中文書籍格式）

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

---

詳細設計模板

目錄

1 概述

1.1 目標

應包含以下幾個方面的內容：

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

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

1.2 范圍

概述本文檔所包含的內容

2 模塊1詳細設計

2.1 類1

2.1.1 簡介

詳細描述CLASS1的職責和功能；必要時，可描述本類與相關類之間的靜態/動態關系。

2.1.2 類圖

提供類的結構圖

2.1.3 狀態設計

可用狀態圖來描述類的狀態信息

2.1.4 屬性

可先定義相關的數據結構。.

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

2.1.5 方法

下面針對每個方法進行說明。

1. 方法1

（1）方法描述

Prototype	方法的聲明，包含可見性
函數原型
Description	描述本方法的功能
功能描述
Calls調用函數	被本函數調用的函數清單（非系統函數）
Called By被調用函數	調用本函數的函數清單（非系統函數）, 可選
Input輸入參數	描述每個輸入參數的含義、內存管理原則
Output輸出參數	描述每個輸出參數的含義、內存管理原則
Return返回值	描述返回值的含義
Exception拋出異常	描述可能拋出的異常

（2）Implementation Description實現描述

使用偽代碼、流程圖等來描述本方法的詳細實現。這部分是詳細設計的重點。

3 模塊2詳細設計

3.1 類1

3.1.1 簡介

詳細描述CLASS1的職責和功能；必要時，可描述本類與相關類之間的靜態/動態關系。

3.1.2 類圖

提供類的結構圖

3.1.3 狀態設計

可用狀態圖來描述類的狀態信息

3.1.4 屬性

可先定義相關的數據結構。.

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

3.1.5 方法

下面針對每個方法進行說明。

2. 方法1

（1）方法描述

Prototype	方法的聲明，包含可見性
函數原型
Description	描述本方法的功能
功能描述
Calls調用函數	被本函數調用的函數清單（非系統函數）
Called By被調用函數	調用本函數的函數清單（非系統函數）, 可選
Input輸入參數	描述每個輸入參數的含義、內存管理原則
Output輸出參數	描述每個輸出參數的含義、內存管理原則
Return返回值	描述返回值的含義
Exception拋出異常	描述可能拋出的異常

（2）Implementation Description實現描述

使用偽代碼、流程圖等來描述本方法的詳細實現。這部分是詳細設計的重點。

4 數據庫詳細設計(可選)

描述存儲過程、觸發器等的詳細實現

4.1 存儲過程1/觸發器1的名稱

（1）Descriptions語法

Prototype	原型描述
原型
Description	描述實現的功能
功能描述
使用的數據庫對象
Input輸入參數	描述每個輸入參數的含義
Output輸出參數	描述每個輸出參數的含義
Return返回值	描述返回值的含義

（2）Implementation Description實現描述

Pseudo codes could be used to depict the definitions.

使用偽代碼來描述詳細實現。這部分是詳細設計的重點。

5 錯誤處理

5.1 系統錯誤

描述象內存分配失敗，任務創建失敗等錯誤是如何被處理的。

5.2 接口錯誤

描述將要產生并給外部實體用的錯誤碼

5.3 協議錯誤

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

---

軟件設計說明

目錄

1　范圍

1.1　標識

本條應描述本文檔所適用的系統、接口實體和接口的完整標識，適用時，包括其標識號、名稱、縮略名、版本號和發布號。

1.2　系統概述

本條應概述本文檔所適用的系統和軟件的用途。它還應描述系統與軟件的一般特性；概述系統開發、運行和維護的歷史；標識項目的需方、用戶、開發方和保障機構等；標識當前和計劃的運行現場；列出其他有關文檔。

1.3　文檔概述

本條應概述本文檔的用途和內容，并描述與它的使用有關的保密性方面的要求。

2　引用文檔

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

3　CSCI級設計決策

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

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

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

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

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

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

4　CSCI體系結構設計

本章應分為以下幾條描述CSCI體系結構設計。如果設計的全部或部分依賴于系統的狀態或方式，此依賴性應予指明。如果設計信息在多于一個條中出現，它只需被提供一次，而在其他條中引用。本條應提供或引用為了理解設計所需要的設計約定。

4.1　CSCI部件

本條應描述：

a) 構成該CSCI的所有軟件單元。應賦予每個軟件單元一個項目唯一的標識符。

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

b) 軟件單元的靜態（如，由…組成）關系。根據所選擇的軟件設計方法學，可以給出多種關系（例如，采用面向對象的設計方法時，本條既可給出類和對象結構，也可給出CSCI的模塊和過程結構）。

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

d) 每個軟件單元的開發狀態／類型（如新開發、按原樣重用已有的設計或軟件、再工程的已有的設計或軟件、為重用而要開發的軟件等，為構建版N計劃的軟件）。針對現有的設計或軟件，本說明應提供標識信息，例如名字、版本、文檔引用、庫等。

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

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

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

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

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

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

f) 標識實現每個軟件單元的軟件放置在哪個程序庫中。

4.2　執行方案

本條應說明軟件單元間的執行方案，可采用圖表和描述，來說明軟件單元間的動態關系，即CSCI運行期間軟件單元間的相互作用情況，（若適用）應包括執行控制流程、數據流、動態控制序列、狀態轉換圖、時序圖、單元間的優先關系、中斷處理、時序／排序關系、例外處理、并發執行、

動態分配與去除分配、對象／進程/任務的動態創建／刪除、以及動態行為的其他方面。

4.3　接口設計

4.3.1　接口標識和接口圖

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

4.3.2　（接口的項目唯一的標識符）

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

a) 接口實體分配給接口的優先級。

b) 要實現的接口類型（例如實時數據傳輸、數據的存儲和檢索等）。

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

1) 名稱／標識符：

a．項目唯一的標識符；

b．非技術（自然語言）名稱；

c．數據元素名稱；

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

e．縮略名或同義名。

2) 教據類型（字母、數字、整數等）。

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

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

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

6) 準確性（正確程度）和精度（有效數位數）。

7)優先級、定時、頻率、容量、序列以及其他約束條件（例如數據元素是否可以被更新、業務規則是否適用）。

8) 保密性約束。

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

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

1) 名稱／標識符：

a．項目唯一的標識符； l

b．非技術（自然語言）名稱； ：

c．技術名稱（如在代碼或數據庫中的記錄名或數據結構名）：

d．縮略名或同義名。

2) 數據元素組合體中的數據元素及其結構（編號、順序和分組情況）。

3) 介質（例如磁盤）以及介質上數據元素／數據組合體的結構。

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

5) 數據組合體之間的關系，如排序／存取特性。

6) 優先級、定時、頻率、容量、序列及其他約束，例如數據組合體是否可被更新、業務規則是否適用。

7) 保密性約束。

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

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

1) 項目唯一的標識符；

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

3) 消息格式；

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

5) 數據傳輸率、周期或非周期、傳輸間隔；

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

7) 傳輸服務，包括：優先級和等級：

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

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

1) 項目唯一的標識符；

2) 協議的優先級別／層次；

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

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

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

6) 狀態、標識和其他報告特性。

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

5　CSCI軟件詳細設計

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

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

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

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

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

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

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

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

1) 該軟件單元執行啟動時，其內部起作用的條件。

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

3) 對每個輸入的響應以及響應時間，包括數據轉換、重命名以及數據傳輸操作。

4) 在軟件單元運行期間的操作順序和動態控制序列，包括：

a．順序控制的方法；

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

c．進出內存的數據傳輸；

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

6　需求的可追蹤性

本章應包含：

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

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

7　注釋

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

---

軟件用戶手冊

目錄

1 范圍

1.1 標識

a) 本文檔的標題：；

b) 本文檔的標識：；

c) 本文檔的版本號：；

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

1.2 系統概述

注：本條應概述本文檔所適用系統和軟件的用途。它還應描述系統與軟件的一般特性;概述系統開發、運行和維護的歷史;標識項目的需方、用戶、開發方和保障機構等;標識當前和計劃的運行現場，列出其他有關文檔.

1.3 文檔概述

注：本節概述該文檔的用途和內容，并描述與其使用有關的保密性或私密性要求。

2 引用文檔

注：本章應列出引用文檔的編號、標題、編寫單位、修訂版及日期

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

[AAA] 作者，《XXX書》，機構名稱，日期

3 軟件綜述

3.1 軟件應用

本條應簡要說明軟件預期的用途，并應描述對軟件使用所期望的能力、運行改進和受益情況。

3.2 軟件清單

系統運行所提供軟件如表 31：

表 31軟件內容清單

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

3.3 軟件環境

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

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

b) 應提供的通信設備:

c) 應提供的其他軟件，例如操作系統、數據庫、數據文件、實用程序和其他的支持系統:

1) 應提供的表格、規程或其他的手工操作:

2) 應提供的其他設施、設備或資源。

3.4 軟件組織和操作概述

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

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

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

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

2) 軟件產生的輸出類型、數量、準確性和速率:

3) 典型的響應時間和影響它的因素;

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

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

6) 預期的錯誤率:

7) 預期的可靠性。

c) 該軟件執行的功能與接口系統、組織或位置之間的關系。

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

3.5 意外事故及運行的備用狀態和方式

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

3.6 保密性

本條應概述與本軟件相關的保密性考慮，適用時還應包括對軟件或文檔進行非授權復制的警告信息。

3.7 幫助和問題報告

本條應標識聯系方式、獲得幫助和報告軟件使用中遇到的問題所應遵循的規程。

4 軟件入門

4.1 軟件的首次用戶

4.1.1 熟悉設備

4.1.2 訪問控制

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

4.1.3 安裝和設置

可參照章節3.3.3.1章節3.3.3.1的具體操作方法。

4.2 啟動

4.3 停止和掛起

5 使用指南

5.1 能力

5.2 約定

5.3 處理規程

5.3.1 軟件的使用

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

5.4 有關的處理

本條應標識并描述任何關于未被用戶直接調用，并且在5.3中也未描述的由軟件執行的批處理、脫機處理或后臺處理，并應說明支持這種處理的用戶的責任。

5.5 數據備份

本條應描述創建和保留備份數據的規程，這些備份數據在發生錯誤、缺陷、誤動作或事故時可

以用來代替主要的數據拷貝。

5.6 錯誤、故障和緊急情況下的恢復

本條應給出從發生錯誤或故障中重啟或恢復的詳細規程，以及確保緊急事件下運行連續性的詳細規程。

5.6.1 錯誤信息列表

1) 創建數據庫失敗：可能原因為數據庫未安裝或者數據庫安裝時出現問題；

2) 通信服務器軟件無法運行：可能原因沒有創建本軟件的數據庫；

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

5.6.2 常見問題處理

5.6.3 數據恢復

5.7 消息

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

5.8 快速參考指南

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

6 注釋

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