某信息技術(shù)公司系統(tǒng)設(shè)計報告編寫規(guī)范

1、系統(tǒng)設(shè)計報告編寫規(guī)范 Ver1.0 P-4/4系統(tǒng)設(shè)計報告編寫規(guī)范文件編號： NW506101 生效日期： 2004-2-20受控編號：密級：秘密版次：Ver1.0修改狀態(tài)：總頁數(shù)19正文4附錄15編制：張俊嶺、鄭澤梅審核：批準：中科海鑫信息技術(shù)有限公司（版權(quán)所有，翻版必究）文件修改控制修改記錄編號修改狀態(tài)修改頁碼及條款修改人審核人批準人修改日期目錄1. 目的2. 適用范圍3. 術(shù)語及縮略語4. 編寫規(guī)范4.1 排版規(guī)范4.2 模板使用5. 引用文件6. 附錄1. 目的系統(tǒng)設(shè)計報告主要為使軟件產(chǎn)品和軟件項目滿足規(guī)定的軟件規(guī)格要求而確定軟件系統(tǒng)的體系結(jié)構(gòu)、組成成分、數(shù)據(jù)組織、模塊、內(nèi)外部接口。主

2、要任務(wù)有：1) 建立軟件產(chǎn)品和軟件項目目標系統(tǒng)的總體結(jié)構(gòu)。對于大規(guī)模軟件系統(tǒng)，應(yīng)分為若干子系統(tǒng)，在本報告中只說明總體設(shè)計，然后為每個子系統(tǒng)編寫系統(tǒng)設(shè)計報告；2) 總體設(shè)計；3) 模塊設(shè)計；4) 涉及使用數(shù)據(jù)庫的設(shè)計需編寫數(shù)據(jù)庫設(shè)計。2. 適用范圍適用于軟件開發(fā)設(shè)計階段的系統(tǒng)設(shè)計報告的編寫。3. 術(shù)語及縮略語本程序采用NQ402100質(zhì)量手冊中的術(shù)語和縮略語及其定義。4. 編寫規(guī)范4.1 排版規(guī)范1） 整個規(guī)范由2節(jié)構(gòu)成，模板單獨一節(jié)。2） 正文樣式采用“規(guī)范正文”。3） 標題編號采用每節(jié)獨立編號。4.2 模板使用系統(tǒng)設(shè)計報告的編寫可依據(jù)具體情況選用摸板的格式或編寫指南的格式。1） 拷貝規(guī)范。2

3、） 刪除第一節(jié)（系統(tǒng)設(shè)計報告封面前的所有頁）。3） 在修改完內(nèi)容后，更新目錄域和相關(guān)的頁數(shù)域。5. 引用文件(無)6. 附錄以下部分為系統(tǒng)設(shè)計報告的模板與編寫指南。中科海鑫信息技術(shù)有限公司系統(tǒng)設(shè)計報告2/5密級：機密文檔編號：第 版分冊名稱：第 冊/共 冊項目名稱（項目編號）系統(tǒng)設(shè)計報告（部門名稱）中科海鑫信息技術(shù)有限公司總頁數(shù)正文附錄生效日期： 年 月 日編制：審核：批準：目錄1. 引言1.1 目的1.2 背景1.3 術(shù)語1.4 參考資料2. 總體設(shè)計2.1 系統(tǒng)運行環(huán)境2.2 軟件功能描述2.3 軟件結(jié)構(gòu)2.4 技術(shù)路線2.5 外部接口2.5.1 用戶接口2.5.2 軟件接口2.5.3 其

4、它接口3. 模塊設(shè)計3.1 功能3.2 性能3.3 內(nèi)部接口3.4 外部存貯結(jié)構(gòu)設(shè)計4. 故障處理說明5. 數(shù)據(jù)庫設(shè)計5.1 數(shù)據(jù)字典設(shè)計5.2 安全保密設(shè)計中科海鑫信息技術(shù)有限公司系統(tǒng)設(shè)計報告4/51.引言1.1目的說明編寫本系統(tǒng)設(shè)計說明書的目的。1.2背景：說明理解本報告所需的背景，如與公司其它軟件之間的聯(lián)系等。1.3術(shù)語列出本系統(tǒng)設(shè)計說明書中專門術(shù)語的定義和英文縮寫詞的原詞組。1.4參考資料：列出編寫參考的文件、資料、技術(shù)標準以及他們的作者、標題、編號、發(fā)布日期和出版單位。編號資料名稱簡介作者日期出版單位列出編寫本報告時需查閱的IntenetInternet上雜志、專業(yè)著作、技術(shù)標準以及

5、他們的網(wǎng)址。網(wǎng)點簡介2. 總體設(shè)計2.1 系統(tǒng)運行環(huán)境給出本軟件系統(tǒng)運行所需的基本軟/硬件環(huán)境、使用本軟件系統(tǒng)典型用戶的設(shè)備分布圖及設(shè)備上相應(yīng)軟件配置。軟件環(huán)境包括：操作系統(tǒng)、數(shù)據(jù)庫、以及其它支撐軟件；硬件環(huán)境包括：主機類型、網(wǎng)絡(luò)類型、存儲器容量、其它特殊設(shè)備。2.2 軟件功能描述描述被開發(fā)軟件的功能，如有同等作用的文件（如已編寫的軟件功能規(guī)格說明書）則可直接在此引述該文件名及歸檔的部門即可。2.3 軟件結(jié)構(gòu)以圖表形式給出軟件子系統(tǒng)結(jié)構(gòu)和模塊組成結(jié)構(gòu)。凡單獨編寫系統(tǒng)設(shè)計報告的子系統(tǒng)，其內(nèi)部自用的模塊不必列出。2.4 技術(shù)路線給出本軟件系統(tǒng)在實現(xiàn)過程中所采用的技術(shù)路線、方法。對比較新的技術(shù)給予詳

6、細的闡述及必要的說明，在可能的情況下給出相應(yīng)的技術(shù)參考資料。2.5 外部接口2.5.1 用戶接口描述該軟件與用戶的接口，包括用戶輸入輸出界面樣式、操作方式和界面間的轉(zhuǎn)移關(guān)系。如具有等同作用的文件（如使用開發(fā)工具編寫的界面原型程序等），本處僅需列出該文件名、保管部門即可。2.5.2 軟件接口描述該軟件與其它系統(tǒng)的軟件接口，主要說明其它系統(tǒng)提供的編程接口和本系統(tǒng)向其它系統(tǒng)提供的編程接口，如具有等同作用的文件（如包含接口說明及注釋的源文件程序頭文件、接口幫助的超文本文件等），本處僅需列出該文件名、保管部門即可。2.5.3 其它接口描述該軟件與其它系統(tǒng)的其它類型接口，主要說明其它系統(tǒng)提供的和本系統(tǒng)向其

7、它系統(tǒng)提供的硬件接口、通信協(xié)議及規(guī)程、數(shù)據(jù)交換格式等，如具有等同作用的文件，本處僅需列出該文件名、保管部門即可。3. 模塊設(shè)計3.1 功能簡述各模塊的功能。3.2 性能說明對各模塊的性能要求，包括精度、時間特性和處理速度。3.3 內(nèi)部接口說明各模塊之間接口，包括：1) 各模塊的用途、使用(調(diào)用)方式；2) 說明其每個子程序（方法，Method）、特性（Property）和反饋的事件（Event），相應(yīng)的輸入、輸出項說明；3) 指明各模塊內(nèi)含的各類外部接口，并列出這些外部接口說明材料名。3.4 外部存貯結(jié)構(gòu)設(shè)計說明本系統(tǒng)存貯于磁盤等持久性存貯介質(zhì)，而且不是由數(shù)據(jù)庫管理系統(tǒng)進行管理的數(shù)據(jù)的組織結(jié)構(gòu)

8、，包括數(shù)據(jù)名稱、用途、每個數(shù)據(jù)項的標識名、類型和含義，組織結(jié)構(gòu)、訪問方法和存儲要求。系統(tǒng)設(shè)計報告5/54. 故障處理說明說明本系統(tǒng)所采用的基本錯誤處理方法和原則，例如：統(tǒng)一采用C+ try-catch錯誤方法，所有錯誤最終必須以界面形式向用戶說明。用一覽表方式說明各類可能的錯誤或故障出現(xiàn)時系統(tǒng)的處理方法和補救措施。5. 數(shù)據(jù)庫設(shè)計5.1 數(shù)據(jù)字典設(shè)計對數(shù)據(jù)庫設(shè)計中涉及到的各種項目，如數(shù)據(jù)項、記錄、表、數(shù)據(jù)庫等建立數(shù)據(jù)字典，以說明它們的標識符、同義名及有關(guān)信息，并說明對此數(shù)據(jù)字典設(shè)計的基本考慮。凡采用數(shù)據(jù)庫設(shè)計工具（如ER圖設(shè)計工具）生成的數(shù)據(jù)字典，本處僅需列出對應(yīng)的文件名、保管部門即可。5.2

9、 安全保密設(shè)計說明在數(shù)據(jù)庫的設(shè)計中，如何通過區(qū)分不同的訪問者、不同的訪問類型和不同的數(shù)據(jù)對象，進行分別對待而獲得的數(shù)據(jù)庫安全保密設(shè)計考慮。系統(tǒng)設(shè)計報告編寫指南系統(tǒng)設(shè)計報告編寫指南之一 1.Introduction介紹l 描述這個文檔的編寫目的；l 描述這個文檔的適用范圍；l 描述這個文檔的讀者；l 確定這個系統(tǒng)/產(chǎn)品的名稱和/或版本號；l 定義重要的術(shù)語、縮寫詞或縮略語；l 總結(jié)（或給出一個概要）這個文檔的內(nèi)容。2.System Overview系統(tǒng)概述對軟件系統(tǒng)的一般性描述，包括系統(tǒng)的功能和其他與設(shè)計相關(guān)的內(nèi)容。3.Design Considerations設(shè)計上的考慮本節(jié)描述在完成一個完整

10、的設(shè)計解決方案之前必須闡明或解決的問題。3.1Assumptions and Dependencies假設(shè)和依賴l 相關(guān)的軟件和硬件l 操作系統(tǒng)l 最終用戶特征l 在功能上可能發(fā)生的變化3.2 General Constraints一般限制l 描述對軟件系統(tǒng)的設(shè)計有重要影響的全局限制或約束。l 硬件或軟件環(huán)境；l 最終用戶環(huán)境；l 資源的可用性和揮發(fā)性；l 標準的兼容；(option)l 協(xié)同工作的要求；l 接口/協(xié)議的要求；l 數(shù)據(jù)儲存和發(fā)布要求；l 安全性的要求（或其它類似的規(guī)則）；l 內(nèi)存和其它的容量限制；l 性能要求；l 網(wǎng)絡(luò)通信；(option)l 驗證和確認的要求（測試）；l 其他

11、質(zhì)量目標的要求；l 在需求分析說明書中所描述的其它要求。3.3 Goals and Guidelines目標和指導(dǎo)方針描述所有支配軟件系統(tǒng)設(shè)計的目標、指導(dǎo)方針、原則或者優(yōu)先權(quán)。l 盡量保持它簡單易用；l 強調(diào)速度與內(nèi)存使用的矛盾；l 象像對待一個已經(jīng)存在的產(chǎn)品那樣工作、觀察或者體會。3.4 Development Methods開發(fā)方法簡要地描述用于軟件設(shè)計的方法。如果采用正式/已公布的方法，那么就要對這些方法進行詳細描述，同時還要簡單解釋一下為什么采用這個方法或其中的某些部分。4.Architectural Strategies體系結(jié)構(gòu)策略描述所有影響整個系統(tǒng)的組織和結(jié)構(gòu)的設(shè)計決定和/或策略

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

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

14、子章節(jié)來詳細描述某一組件的作用，進一步描述該組件是如何分為子組件的以及各個子組件之間的關(guān)系。6.Policies and Tactics政策和實施策略描述影響系統(tǒng)的接口細節(jié)和系統(tǒng)實現(xiàn)細節(jié)的各個方面：l 選擇特定產(chǎn)品來使用（如編譯器、解釋器、數(shù)據(jù)庫、函數(shù)庫等）；l 工程上的折中；l 編碼規(guī)范和慣例；l 一個或多個子系統(tǒng)、模塊或子程序的協(xié)議；l 選擇某一特定算法或編程用語來實現(xiàn)系統(tǒng)的一部分；l 功能性說明；l 保證需求可回溯性的計劃；l 軟件測試計劃；l 軟件維護計劃；l 最終用戶、軟件、硬件和通信的接口；l 將源代碼按照物理形態(tài)（文件和路徑）進行分層組織；l 如何構(gòu)造和/或產(chǎn)生系統(tǒng)的交付物（如何

15、編譯、鏈接、加載等）。以上各項內(nèi)容必須有相應(yīng)的子章節(jié)進行討論。如果還有其他方案可供選擇時，要說明你沒有選擇這些方案的原因?？梢允褂脠D表、模型、流程圖等形式來描述上述內(nèi)容。7.Detailed System Design詳細設(shè)計在系統(tǒng)體系結(jié)構(gòu)中所描述的絕大多數(shù)組件需要在本章節(jié)進行更深一步的討論，同樣，其它低層的組件和子組件也需要描述。為每個組件建立一個子章節(jié)來詳細描述組件，包括以下內(nèi)容：l Classification 分類 組件的種類，例如是一個子系統(tǒng)、模塊、類、包、函數(shù)、文件等等。l Definition 定義組件的確切用途和語義?？赡苄枰獏⒄招枨笳f明。l Responsibilities

16、責任該組件的主要責任和/或行為，要完成什么？扮演什么角色？給客戶提供哪寫服務(wù)？可能需要參照需求說明。l Constraints 約束與該組件相關(guān)的任何假設(shè)、限制、或者約束，如時間、存儲或組件狀態(tài)，還可能包括與該組件進行交互的規(guī)則（前提條件，后置條件，不變量，其它在輸入和輸出值、局部或全局值上的限制，數(shù)據(jù)格式和數(shù)據(jù)存取，同步，例外等）。l Composition 合成 描述組成該組件的子組件及其用途。l Uses/Interactions 用戶/接口描述該組件與其它組件之間的關(guān)系，如該組件被哪些組件所使用？該組件使用了哪些其它組件？這關(guān)系到所使用的交互作用的方法。面向?qū)ο蟮脑O(shè)計必須描述那些已知的

17、和預(yù)期的子類、超類和元類。l Resources 資源描述這個組件所管理的、影響的和使用的所有資源，如內(nèi)存、處理器、打印機、數(shù)據(jù)庫或軟件庫，要描述可能存在的資源競爭、死鎖等情況以及相應(yīng)的解決方案。l Processing 過程描述該組件的執(zhí)行過程，包括所使用的算法、狀態(tài)的變化、相關(guān)的時間或空間的復(fù)雜性、并發(fā)、創(chuàng)建方法、初始化、清除和例外情況的處理。l Interface/Exports 界面/出口描述該組件所提供的服務(wù)，如資源、數(shù)據(jù)、類型、常量、子程序和例外等集合，明確定義每一個服務(wù)元素，即分類、定義、責任、約束、組合、使用、資源、處理和接口的描述。7.1 Detailed Subsystem

18、 Design詳細子系統(tǒng)設(shè)計在本章節(jié)內(nèi)對該組件進行更詳細描述，可使用一些復(fù)雜的圖表來顯示組件結(jié)構(gòu)、行為、或者信息/控制流。8.Glossary詞匯表列出在文檔中所定義的術(shù)語和概念。9.Bibliography參考書目一個參考書目和/或相關(guān)出版物的列表。系統(tǒng)設(shè)計報告編寫指南之二.Objectives 目標描述系統(tǒng)設(shè)計報告的內(nèi)容和目的。.Scope 范圍適用于指導(dǎo)包含設(shè)計階段的項目編寫系統(tǒng)設(shè)計報告。3. References 參考4. Outstanding Issues 尚存主要問題5. Approvals 批準R&D單位負責人6. Responsibilities職責6.1開發(fā)部長對系

19、統(tǒng)設(shè)計報告進行審核；6.2項目管理部門組織對系統(tǒng)設(shè)計報告進行評審；6.3設(shè)計人員提交符合本指南的系統(tǒng)設(shè)計報告。6.4設(shè)計人員對設(shè)計階段的文檔進行配置管理。7. Template 模板7.1Introduction 緒論l 項目概述；l 所設(shè)計的產(chǎn)品的概述。7.2System Description 系統(tǒng)描述7.2.1Support for Requirements 對需求的支持l 設(shè)計滿足需求的程度；l 設(shè)計未能完全滿足的需求及其原因。7.2.2 System Purpose 系統(tǒng)目標簡述所開發(fā)的系統(tǒng)，如果本系統(tǒng)同其他系統(tǒng)有不論是手工還是計算機方面的關(guān)系，也要描述?？蓞⒖夹枨蠓治鰣蟾娴膬?nèi)容。7

20、.2.3Inputs and Outputs 輸入和輸出詳細描述系統(tǒng)的所有輸入和輸出，包括界面設(shè)計、報表設(shè)計，參數(shù)格式。7.2.4Functions功能描述系統(tǒng)所提供的所有功能。7.2.5Stored data 數(shù)據(jù)存貯簡述系統(tǒng)的數(shù)據(jù)文件。7.2.6Security and backup 安全和備份系統(tǒng)在安全和備份方面的考慮與設(shè)計，包括回滾和恢復(fù)。7.2.7Exception handling 例外處理系統(tǒng)產(chǎn)生的所有錯誤信息的列表，包括錯誤發(fā)生的條件以及所采取的措施。所有例外情況的列表，以及系統(tǒng)所采取的措施。7.2.8Impact assessment 影響評估描述系統(tǒng)對現(xiàn)有環(huán)境的重要影響，如

21、工序的變化，工作量的變化和硬件的變化。可以參照需求分析報告的內(nèi)容。7.3User Procedures 用戶規(guī)程7.3.1System navigation 系統(tǒng)導(dǎo)航描述那些使用戶能充分使用系統(tǒng)的規(guī)則；7.3.2Routine 例程l 描述在正常工作環(huán)境下，系統(tǒng)預(yù)期的使用方法；l 使用流程圖來描述例程，流程圖要帶有輔助描述，描述那些使用每個功能的用戶的類型。7.3.3Exception 例外處理描述系統(tǒng)在異常情況下所使用的處理方式，如網(wǎng)絡(luò)失效時的數(shù)據(jù)恢復(fù)。7.3.4Installation 安裝描述系統(tǒng)的安裝過程。7.4System architecture 系統(tǒng)結(jié)構(gòu)7.4.1Design principles 設(shè)計原則描述系統(tǒng)設(shè)計所采用的策略，如用戶界