系統(tǒng)設計報告編寫規(guī)范
1. 目的
系統(tǒng)設計報告主要為使軟件產品和軟件項目滿足規(guī)定的軟件規(guī)格要求而確定軟件系統(tǒng)的體系結構、組成成分、數(shù)據(jù)組織、模塊、內外部接口。主要任務有：
1) 建立軟件產品和軟件項目目標系統(tǒng)的總體結構。對于大規(guī)模軟件系統(tǒng)，應分為若干子系統(tǒng)，在本報告中只說明總體設計，然后為每個子系統(tǒng)編寫《系統(tǒng)設計報告》；
2) 總體設計；
3) 模塊設計；
4) 涉及使用數(shù)據(jù)庫的設計需編寫數(shù)據(jù)庫設計。

2. 適用范圍
適用于軟件開發(fā)設計階段的《系統(tǒng)設計報告》的編寫。

3. 術語及縮略語
本程序采用NQ402100《質量手冊》中的術語和縮略語及其定義。

4. 編寫規(guī)范
4.1 排版規(guī)范
1） 整個規(guī)范由2節(jié)構成，模板單獨一節(jié)。
2） 正文樣式采用“規(guī)范正文”。
3） 標題編號采用每節(jié)獨立編號。
4.2 模板使用
系統(tǒng)設計報告的編寫可依據(jù)具體情況選用摸板的格式或編寫指南的格式。
1） 拷貝規(guī)范。
2） 刪除第一節(jié)（系統(tǒng)設計報告封面前的所有頁）。
3） 在修改完內容后，更新目錄域和相關的頁數(shù)域。

5. 引用文件
(無)

6. 附錄
以下部分為系統(tǒng)設計報告的模板與編寫指南。
密級：機密
文檔編號： 第 版
分冊名稱： 第 冊/共 冊








項目名稱（項目編號）

系統(tǒng)設計報告



（部門名稱）












沈陽東大阿爾派軟件股份有限公司




總頁數(shù) 正文 附錄 生效日期： 年 月 日
編制： 審核： 批準：


目錄

1. 引言 1
1.1 目的 1
1.2 背景 1
1.3 術語 1
1.4 參考資料 1
2. 總體設計 1
2.1 系統(tǒng)運行環(huán)境 1
2.2 軟件功能描述 1
2.3 軟件結構 1
2.4 技術路線 1
2.5 外部接口 2
2.5.1 用戶接口 2
2.5.2 軟件接口 2
2.5.3 其它接口 2
3. 模塊設計 2
3.1 功能 2
3.2 性能 2
3.3 內部接口 2
3.4 外部存貯結構設計 2
4. 故障處理說明 2
5. 數(shù)據(jù)庫設計 2
5.1 數(shù)據(jù)字典設計 2
5.2 安全保密設計 2

1. 引言
1.1 目的
說明編寫本《系統(tǒng)設計說明書》的目的。
1.2 背景：
說明理解本報告所需的背景，如與公司其它軟件之間的聯(lián)系等。
1.3 術語
列出本系統(tǒng)設計說明書中專門術語的定義和英文縮寫詞的原詞組。
1.4 參考資料：
列出編寫參考的文件、資料、技術標準以及他們的作者、標題、編號、發(fā)布日期和出版單位。
編號 資料名稱 簡介 作者 日期 出版單位


列出編寫本報告時需查閱的Intenet上雜志、專業(yè)著作、技術標準以及他們的網(wǎng)址。
網(wǎng)點 簡介



2. 總體設計
2.1 系統(tǒng)運行環(huán)境
給出本軟件系統(tǒng)運行所需的基本軟/硬件環(huán)境、使用本軟件系統(tǒng)典型用戶的設備分布圖及設備上相應軟件配置。軟件環(huán)境包括：操作系統(tǒng)、數(shù)據(jù)庫、以及其它支撐軟件；硬件環(huán)境包括：主機類型、網(wǎng)絡類型、存儲器容量、其它特殊設備。
2.2 軟件功能描述
描述被開發(fā)軟件的功能，如有同等作用的文件（如已編寫的《軟件功能規(guī)格說明書》）則可直接在此引述該文件名及歸檔的部門即可。
2.3 軟件結構
以圖表形式給出軟件子系統(tǒng)結構和模塊組成結構。凡單獨編寫《系統(tǒng)設計報告》的子系統(tǒng)，其內部自用的模塊不必列出。
2.4 技術路線
給出本軟件系統(tǒng)在實現(xiàn)過程中所采用的技術路線、方法。對比較新的技術給予詳細的闡述及必要的說明，在可能的情況下給出相應的技術參考資料。
2.5 外部接口
2.5.1 用戶接口
描述該軟件與用戶的接口，包括用戶輸入輸出界面樣式、操作方式和界面間的轉移關系。如具有等同作用的文件（如使用開發(fā)工具編寫的界面原型程序等），本處僅需列出該文件名、保管部門即可。
2.5.2 軟件接口
描述該軟件與其它系統(tǒng)的軟件接口，主要說明其它系統(tǒng)提供的編程接口和本系統(tǒng)向其它系統(tǒng)提供的編程接口，如具有等同作用的文件（如包含接口說明及注釋的源文件程序頭文件、接口幫助的超文本文件等），本處僅需列出該文件名、保管部門即可。
2.5.3 其它接口
描述該軟件與其它系統(tǒng)的其它類型接口，主要說明其它系統(tǒng)提供的和本系統(tǒng)向其它系統(tǒng)提供的硬件接口、通信協(xié)議及規(guī)程、數(shù)據(jù)交換格式等，如具有等同作用的文件，本處僅需列出該文件名、保管部門即可。

3. 模塊設計
3.1 功能
簡述各模塊的功能。
3.2 性能
說明對各模塊的性能要求，包括精度、時間特性和處理速度。
3.3 內部接口
說明各模塊之間接口，包括：
1) 各模塊的用途、使用(調用)方式；
2) 說明其每個子程序（方法，Method）、特性（Property）和反饋的事件（Event），相應的輸入、輸出項說明；
3) 指明各模塊內含的各類外部接口，并列出這些外部接口說明材料名。
3.4 外部存貯結構設計
說明本系統(tǒng)存貯于磁盤等持久性存貯介質，而且不是由數(shù)據(jù)庫管理系統(tǒng)進行管理的數(shù)據(jù)的組織結構，包括數(shù)據(jù)名稱、用途、每個數(shù)據(jù)項的標識名、類型和含義，組織結構、訪問方法和存儲要求。


4. 故障處理說明
說明本系統(tǒng)所采用的基本錯誤處理方法和原則，例如：統(tǒng)一采用C++ try-catch錯誤方法，所有錯誤最終必須以界面形式向用戶說明。用一覽表方式說明各類可能的錯誤或故障出現(xiàn)時系統(tǒng)的處理方法和補救措施。

5. 數(shù)據(jù)庫設計
5.1 數(shù)據(jù)字典設計
對數(shù)據(jù)庫設計中涉及到的各種項目，如數(shù)據(jù)項、記錄、表、數(shù)據(jù)庫等建立數(shù)據(jù)字典，以說明它們的標識符、同義名及有關信息，并說明對此數(shù)據(jù)字典設計的基本考慮。凡采用數(shù)據(jù)庫設計工具（如ER圖設計工具）生成的數(shù)據(jù)字典，本處僅需列出對應的文件名、保管部門即可。
5.2 安全保密設計
說明在數(shù)據(jù)庫的設計中，如何通過區(qū)分不同的訪問者、不同的訪問類型和不同的數(shù)據(jù)對象，進行分別對待而獲得的數(shù)據(jù)庫安全保密設計考慮。

系統(tǒng)設計報告編寫指南之一

1. Introduction介紹
 描述這個文檔的編寫目的；
 描述這個文檔的適用范圍；
 描述這個文檔的讀者；
 確定這個系統(tǒng)/產品的名稱和/或版本號；
 定義重要的術語、縮寫詞或縮略語；
 總結（或給出一個概要）這個文檔的內容。

2. System Overview系統(tǒng)概述
對軟件系統(tǒng)的一般性描述，包括系統(tǒng)的功能和其他與設計相關的內容。

3. Design Considerations設計上的考慮
本節(jié)描述在完成一個完整的設計解決方案之前必須闡明或解決的問題。
3.1 Assumptions and Dependencies假設和依賴
 相關的軟件和硬件
 操作系統(tǒng)
 最終用戶特征
 在功能上可能發(fā)生的變化
3.2 General Constraints一般限制
 描述對軟件系統(tǒng)的設計有重要影響的全局限制或約束。
 硬件或軟件環(huán)境；
 最終用戶環(huán)境；
 資源的可用性和揮發(fā)性；
 標準的兼容；(option)
 協(xié)同工作的要求；
 接口/協(xié)議的要求；
 數(shù)據(jù)儲存和發(fā)布要求；
 安全性的要求（或其它類似的規(guī)則）；
 內存和其它的容量限制；
 性能要求；
 網(wǎng)絡通信；(option)
 驗證和確認的要求（測試）；
 其他質量目標的要求；
 在需求分析說明書中所描述的其它要求。
3.3 Goals and Guidelines目標和指導方針
描述所有支配軟件系統(tǒng)設計的目標、指導方針、原則或者優(yōu)先權。
 盡量保持它簡單易用；
 強調速度與內存使用的矛盾；
 象對待一個已經存在的產品那樣工作、觀察或者體會。
3.4 Development Methods開發(fā)方法
簡要地描述用于軟件設計的方法。如果采用正式/已公布的方法，那么就要對這些方法進行詳細描述，同時還要簡單解釋一下為什么采用這個方法或其中的某些部分。

4. Architectural Strategies體系結構策略
描述所有影響整個系統(tǒng)的組織和結構的設計決定和/或策略，這些策略深入描述系統(tǒng)體系結構所使用的關鍵技術和機制。對于每個設計決定和/或策略都要描述其產生原因（可能要引用前面闡述的設計目標和原則），以及它們是如何得到均衡和折中的，涉及內容：
 使用特定類型產品（編程語言、數(shù)據(jù)庫、函數(shù)庫等）；
 重用現(xiàn)有組件；
 軟件未來擴展和升級的計劃；
 用戶接口模型（或系統(tǒng)的輸入和輸出模型）；
 硬件或軟件接口模型；
 錯誤檢測和恢復；
 內存管理策略；
 外部數(shù)據(jù)庫和/或數(shù)據(jù)存儲管理和維護；
 網(wǎng)絡上分布式數(shù)據(jù)或控制；
 控制的一般方法；
 并發(fā)和同步；
 通信機制；
 其它資源的管理。
每一個被采用的重要戰(zhàn)略必須在相應的子章節(jié)內加以討論。

5. System Architecture系統(tǒng)體系結構
在本節(jié)應該在一個較高的層次來說明如何將系統(tǒng)的功能劃分給各個子系統(tǒng)或組件，不要涉及這些組件本身的細節(jié)（后面有一個小節(jié)專門來詳細描述組件）。本節(jié)的主要目標是描述系統(tǒng)是如何進行分解、這樣分解的原因以及各部分是如何協(xié)作工作以完成預定功能。
在較高的層次上描述系統(tǒng)所要承擔的主要工作責任、系統(tǒng)所扮演的各種角色；描述如何將系統(tǒng)劃分成各個組件/子系統(tǒng)，每個組件/子系統(tǒng)的作用是什么；描述高層組件之間是如何協(xié)調工作已完成預期的功能；進行系統(tǒng)分解時所采用的基本原則；可以使用圖表、模型、流程圖等形式來描述上述內容。
5.1 Subsystem Architecture子系統(tǒng)的體系結構
建立一個子章節(jié)來詳細描述某一組件的作用，進一步描述該組件是如何分為子組件的以及各個子組件之間的關系。

6. Policies and Tactics政策和實施策略
描述影響系統(tǒng)的接口細節(jié)和系統(tǒng)實現(xiàn)細節(jié)的各個方面：
 選擇特定產品來使用（如編譯器、解釋器、數(shù)據(jù)庫、函數(shù)庫等）；
 工程上的折中；
 編碼規(guī)范和慣例；
 一個或多個子系統(tǒng)、模塊或子程序的協(xié)議；
 選擇某一特定算法或編程用語來實現(xiàn)系統(tǒng)的一部分；
 功能性說明；
 保證需求可回溯性的計劃；
 軟件測試計劃；
 軟件維護計劃；
 最終用戶、軟件、硬件和通信的接口；
 將源代碼按照物理形態(tài)（文件和路徑）進行分層組織；
 如何構造和/或產生系統(tǒng)的交付物（如何編譯、鏈接、加載等）。
以上各項內容必須有相應的子章節(jié)進行討論。如果還有其他方案可供選擇時，要說明你沒有選擇這些方案的原因。可以使用圖表、模型、流程圖等形式來描述上述內容。

7. Detailed System Design詳細設計
在系統(tǒng)體系結構中所描述的絕大多數(shù)組件需要在本章節(jié)進行更深一步的討論，同樣，其它低層的組件和子組件也需要描述。為每個組件建立一個子章節(jié)來詳細描述組件，包括以下內容：
 Classification 分類
組件的種類，例如是一個子系統(tǒng)、模塊、類、包、函數(shù)、文件等等。
 Definition 定義
組件的確切用途和語義?？赡苄枰獏⒄招枨笳f明。
 Responsibilities 責任
該組件的主要責任和/或行為，要完成什么？扮演什么角色？給客戶提供哪寫服務？可能需要參照需求說明。
 Constraints 約束
與該組件相關的任何假設、限制、或者約束，如時間、存儲或組件狀態(tài)，還可能包括與該組件進行交互的規(guī)則（前提條件，后置條件，不變量，其它在輸入和輸出值、局部或全局值上的限制，數(shù)據(jù)格式和數(shù)據(jù)存取，同步，例外等）。
 Composition 合成
描述組成該組件的子組件及其用途。
 Uses/Interactions 用戶/接口
描述該組件與其它組件之間的關系，如該組件被哪些組件所使用？該組件使用了哪些其它組件？這關系到所使用的交互作用的方法。面向對象的設計必須描述那些已知的和預期的子類、超類和元類。
 Resources 資源
描述這個組件所管理的、影響的和使用的所有資源，如內存、處理器、打印機、數(shù)據(jù)庫或軟件庫，要描述可能存在的資源競爭、死鎖等情況以及相應的解決方案。
 Processing 過程
描述該組件的執(zhí)行過程，包括所使用的算法、狀態(tài)的變化、相關的時間或空間的復雜性、并發(fā)、創(chuàng)建方法、初始化、清除和例外情況的處理。
 Interface/Exports 界面/出口
描述該組件所提供的服務，如資源、數(shù)據(jù)、類型、常量、子程序和例外等集合，明確定義每一個服務元素，即分類、定義、責任、約束、組合、使用、資源、處理和接口的描述。
7.1 Detailed Subsystem Design詳細子系統(tǒng)設計
在本章節(jié)內對該組件進行更詳細描述，可使用一些復雜的圖表來顯示組件結構、行為、或者信息/控制流。

8. Glossary詞匯表
列出在文檔中所定義的術語和概念。

9. Bibliography參考書目
一個參考書目和/或相關出版物的列表。

系統(tǒng)設計報告編寫指南之二

1. Objectives 目標
描述系統(tǒng)設計報告的內容和目的。

2. Scope 范圍
適用于指導包含設計階段的項目編寫系統(tǒng)設計報告。

3. References 參考

4. Outstanding Issues 尚存主要問題

5. Approvals 批準
R&D單位負責人

6. Responsibilities 職責
6.1 開發(fā)部長對系統(tǒng)設計報告進行審核；
6.2 項目管理部門組織對系統(tǒng)設計報告進行評審；
6.3 設計人員提交符合本指南的系統(tǒng)設計報告。
6.4 設計人員對設計階段的文檔進行配置管理。

7. Template 模板
7.1 Introduction 緒論
 項目概述；
 所設計的產品的概述。
7.2 System Description 系統(tǒng)描述
7.2.1 Support for Requirements 對需求的支持
 設計滿足需求的程度；
 設計未能完全滿足的需求及其原因。
7.2.2 System Purpose 系統(tǒng)目標
簡述所開發(fā)的系統(tǒng)，如果本系統(tǒng)同其他系統(tǒng)有不論是手工還是計算機方面的關系，也要描述?？蓞⒖夹枨蠓治鰣蟾娴膬热?。
7.2.3 Inputs and Outputs 輸入和輸出
詳細描述系統(tǒng)的所有輸入和輸出，包括界面設計、報表設計，參數(shù)格式。
7.2.4 Functions功能
描述系統(tǒng)所提供的所有功能。
7.2.5 Stored data 數(shù)據(jù)存貯
簡述系統(tǒng)的數(shù)據(jù)文件。
7.2.6 Security and backup 安全和備份
系統(tǒng)在安全和備份方面的考慮與設計，包括回滾和恢復。
7.2.7 Exception handling 例外處理
系統(tǒng)產生的所有錯誤信息的列表，包括錯誤發(fā)生的條件以及所采取的措施。所有例外情況的列表，以及系統(tǒng)所采取的措施。
7.2.8 Impact assessment 影響評估
描述系統(tǒng)對現(xiàn)有環(huán)境的重要影響，如工序的變化，工作量的變化和硬件的變化。可以參照需求分析報告的內容。
7.3 User Procedures 用戶規(guī)程
7.3.1 System navigation 系統(tǒng)導航
描述那些使用戶能充分使用系統(tǒng)的規(guī)則；
7.3.2 Routine 例程
 描述在正常工作環(huán)境下，系統(tǒng)預期的使用方法；
 使用流程圖來描述例程，流程圖要帶有輔助描述，描述那些使用每個功能的用戶的類型。
7.3.3 Exception 例外處理
描述系統(tǒng)在異常情況下所使用的處理方式，如網(wǎng)絡失效時的數(shù)據(jù)恢復。
7.3.4 Installation 安裝
描述系統(tǒng)的安裝過程。
7.4 System architecture 系統(tǒng)結構
7.4.1 Design principles 設計原則
描述系統(tǒng)設計所采用的策略，如用戶界面的形式，所使用的標準產品等。
7.4.2 Design rationale 設計原理
 描述進行設計的依據(jù)，如數(shù)據(jù)庫結構等；
 模塊調用原理：是內部還是外部，是修改還是重建或重用。
7.4.3 Software components and interfaces 軟件組件和接口
 描述系統(tǒng)中的主要組件，包括它們之間傳遞的包和數(shù)據(jù)流；
 數(shù)據(jù)流圖和功能分解圖；
 描述所引用的外部模塊。
7.4.4 Capacity requirements 系統(tǒng)資源需求
估計系統(tǒng)容量等需求的臨界值，如內存、磁盤空間和、傳輸速率等。
7.4.5 System structure 系統(tǒng)結構
描述系統(tǒng)的各模塊是如何連接在一起工作的。
7.5 Data 數(shù)據(jù)
7.5.1 Definitions 定義
對系統(tǒng)中包含的所有數(shù)據(jù)項的描述。
7.5.2 Database design 數(shù)據(jù)庫設計
 對邏輯數(shù)據(jù)庫/文件設計的描述；
 對物理數(shù)據(jù)庫/文件設計的描述；
 數(shù)據(jù)校驗規(guī)則。
7.5.3 Calculations 算法
 定義系統(tǒng)所采用的計算或算法；
 確定實現(xiàn)這些算法的流程。
7.5.4 Data management procedures 數(shù)據(jù)管理程序
描述對系統(tǒng)數(shù)據(jù)的管理流程，如存檔等。
7.6 Module specifications 模塊說明
 詳細描述每個模塊的邏輯、功能或每個模塊的所有狀態(tài)、與其他模塊的關聯(lián)、狀態(tài)的變遷、存在的條件及采取的動作；
 使用簡潔、標準的語言；
 說明每個模塊的輸入和輸出。
7.7 Physical environment 物理環(huán)境
描述建立和運行系統(tǒng)所需要的物理環(huán)境

系統(tǒng)設計報告編寫規(guī)范