概要設計說明書
目錄
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 注釋
注：本章應包含有助于了解本文檔的一般資訊（例如背景資訊、詞彙表、原理）。本章應包含為了解本文檔需要的術語和定義，所有縮略語和它們在文檔中的含義的字母序清單。