軟件系統(tǒng)設(shè)計(jì)說明書模板

1、項(xiàng)目名稱Project Name密級Confidentiality Level僅供收件方查閱項(xiàng)目編號Project ID版本Version文檔編號Document Code1.0Project ID_SD_003XX Software System Design Specification(OO)XX軟件系統(tǒng)設(shè)計(jì)說明書(OO)Prepared by 擬制Date日期Reviewed by評審人Date日期Approved by批準(zhǔn)Date日期版權(quán)所有不得復(fù)制Copyright BroadenGate Technologies, Co., Ltd.All Rights ReservedRevis

2、ion Record修訂記錄Date日期Revision Version 修訂版本CR ID /DefectIDCR/ Defect號Sec No.修改早節(jié)Change Description 修改描述Author作者Catalog目錄 TOC o 1-5 h z HYPERLINK l bookmark47 o Current Document Introduction 簡介6 HYPERLINK l bookmark51 o Current Document Purpose 目的6 HYPERLINK l bookmark55 o Current Document Scope 范圍6 HY

3、PERLINK l bookmark59 o Current Document Name 軟件名稱 6 HYPERLINK l bookmark63 o Current Document 1.2.2Functions 軟件功能 6 HYPERLINK l bookmark67 o Current Document 1.2.3Applications軟件應(yīng)用 6 HYPERLINK l bookmark71 o Current Document Level 0 Design Description 第0層設(shè)計(jì)描述 6 HYPERLINK l bookmark75 o Current Docume

4、nt Software System Context Definition 軟件系統(tǒng)上下文定義6 HYPERLINK l bookmark79 o Current Document Design Considerations (Optional)設(shè)計(jì)思路(可選)6 HYPERLINK l bookmark83 o Current Document Design Alternatives 設(shè)計(jì)可選方案 6 HYPERLINK l bookmark87 o Current Document 2.2.2Design Constraints 設(shè)計(jì)約束 7 HYPERLINK l bookmark94

5、o Current Document 2.2.3Other Design Considerations 其他 7 HYPERLINK l bookmark98 o Current Document Level 1 Design Description 第一層設(shè)計(jì)描述 7 HYPERLINK l bookmark102 o Current Document System Architecture系統(tǒng)結(jié)構(gòu)7 HYPERLINK l bookmark106 o Current Document Description of the Architecture系統(tǒng)結(jié)構(gòu)描述 7 HYPERLINK l b

6、ookmark110 o Current Document Representation of the Business Flow業(yè)務(wù)流程說明7 HYPERLINK l bookmark114 o Current Document Decomposition Description 分解描述8 HYPERLINK l bookmark118 o Current Document Module/Subsystem 1 Description 模塊 1/子系統(tǒng) 1 描述8 HYPERLINK l bookmark124 o Current Document Module/Subsystem 2 D

7、escription 模塊 2/子系統(tǒng) 2 描述8 HYPERLINK l bookmark128 o Current Document Dependency Description 依賴性描述8 HYPERLINK l bookmark132 o Current Document Interface Description接口描述8 HYPERLINK l bookmark136 o Current Document Module/Subsystem 1 Interface Description 模塊 1/子系統(tǒng) 1 的接口描述8 HYPERLINK l bookmark140 o Cur

8、rent Document Module/Subsystem 2 Interface Description 模塊 2/子系統(tǒng) 2 的接口描述8 HYPERLINK l bookmark144 o Current Document Level 2 Design Description 第二層設(shè)計(jì)描述 8 HYPERLINK l bookmark148 o Current Document Module Name (1)模塊 1 名稱 9 HYPERLINK l bookmark152 o Current Document Design Description 模塊設(shè)計(jì)描述 9 HYPERLIN

9、K l bookmark163 o Current Document 4.1.2Function Illustration 功能實(shí)現(xiàn)說明10 HYPERLINK l bookmark167 o Current Document Module Name (2)模塊2名稱 10 HYPERLINK l bookmark171 o Current Document Design Description 模塊設(shè)計(jì)描述 104.2.2Function Illustration 功能實(shí)現(xiàn)說明 10 HYPERLINK l bookmark178 o Current Document Database De

10、sign 數(shù)據(jù)庫設(shè)計(jì)10 HYPERLINK l bookmark182 o Current Document Entities Definition 實(shí)體定義 10 HYPERLINK l bookmark186 o Current Document Decomposition Description 分解描述 10 HYPERLINK l bookmark190 o Current Document 5.1.2Internal Dependency Description 內(nèi)部依賴性描述 10 HYPERLINK l bookmark194 o Current Document Behav

11、iors Definition彳亍為定義 11 HYPERLINK l bookmark198 o Current Document Decomposition Description 分解描述 11 HYPERLINK l bookmark202 o Current Document 5.2.2External Dependency Description 夕卜部依賴性描述 11 HYPERLINK l bookmark206 o Current Document 5.2.3 Internal Dependency Description 內(nèi)部依賴性描述 11 HYPERLINK l boo

12、kmark210 o Current Document Detailed Design of Module模塊詳細(xì)設(shè)計(jì) 11 HYPERLINK l bookmark214 o Current Document Class1 CLASS 的設(shè)計(jì) 11 HYPERLINK l bookmark218 o Current Document Overview介 11 HYPERLINK l bookmark222 o Current Document 6.1.2Class Diagram 類圖 11 HYPERLINK l bookmark226 o Current Document 6.1.3St

13、atus Design 狀態(tài)設(shè)計(jì) 11 HYPERLINK l bookmark230 o Current Document 6.1.4Attributes 屬性 12 HYPERLINK l bookmark234 o Current Document 6.1.5Methods方法 12 HYPERLINK l bookmark238 o Current Document Class2 CLASS的設(shè)計(jì) 12 HYPERLINK l bookmark242 o Current Document Detailed Design of the Database 數(shù)據(jù)庫詳細(xì)設(shè)計(jì) 12 HYPERL

14、INK l bookmark246 o Current Document Stored Procedure1 #/Trigger1# 存儲過程 1#/觸發(fā)器 1#的名稱13 HYPERLINK l bookmark250 o Current Document Stored Procedure 2#/Trigger2# 存儲過程2#/觸發(fā)器2#的名稱13Keywords關(guān)鍵詞：Abstract 摘要：List of abbreviations縮略語清單：v對本文所用縮略語進(jìn)行說明，要求提供每個縮略語的英 文全名和中文解釋。Describe abbreviations in this docume

15、nt, full spelling of theIntroduction 簡介Purpose 目的This section should state the purpose of this document. The intended reader should also be specified here.這部分要描述文檔的目的，并指明文檔的讀者。Scope 范圍Name軟件名稱Identify the software by name.對軟件命名。Functions 軟件功能Explain what the software product(s) will and will not do

16、(either directly or by reference to another related document).解釋軟件產(chǎn)品將完成或不完成的功能(可以直接描述也可以參考相關(guān)文檔)。Applications軟件應(yīng)用Describe the application of the product (either directly or by reference to another software document)描述軟件的應(yīng)用領(lǐng)域(可直接描述也可以參考其他軟件文檔)。Level 0 Design Description 第 0 層設(shè)計(jì)描述Software System Contex

17、t Definiti on軟件系統(tǒng)上下文定義This section should describe the relationships between the software system to be developed and the external entities. Architecture diagrams could be used to describe the architecture and the interactions.本節(jié)描述待開發(fā)軟件系統(tǒng)與外部實(shí)體的關(guān)系，可以使用系統(tǒng)結(jié)構(gòu)圖來描述系統(tǒng)結(jié)構(gòu)和交互關(guān) 系。The description of the external

18、 entities attributes shall be limited to these attributes which will interact with the software design. In lieu of a complete description, reference could be made to relevant documentation of the concerned software entity, e.g. OS Programmers Manual.外部實(shí)體屬性描述只限于描述與本系統(tǒng)軟件設(shè)計(jì)相關(guān)的屬性。考慮到描述的完整性，可參考 相關(guān)軟件實(shí)體文檔，

19、如?腳序員手冊。Design Considerations (Optional設(shè)計(jì)思路何選)Design Alternatives 設(shè)計(jì)可選方案Analyze several alternatives of system design scheme, and specify the scheme that shall be used.對本軟件系統(tǒng)的幾種設(shè)計(jì)方案進(jìn)行分析、比較，并確定所采用的方案。Design Constraints 設(shè)計(jì)約束Standards compliance 遵循標(biāo)準(zhǔn)Describe standards that software system shall comply

20、with.描述本軟件所遵循的標(biāo)準(zhǔn)、規(guī) 范。Hardware Limitations 硬件限制Describe hardware limitations of the software system.描述本軟件系統(tǒng)實(shí)現(xiàn)的硬件限制。Technology Limitations 技術(shù)限制Describe technology limitations of the software system.描述本軟件的技術(shù)限制。Other Design Considerations 其他Describe other design considerations of the software system.描述其

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

22、itecture 系統(tǒng)結(jié)構(gòu)描述The software system architecture should be described here. Architecture diagrams, hierarchical decomposition diagrams, or package diagrams could be used to represent the architecture. And the partitioning principle, such as the architecture defined in a standard protocol, a scheme com

23、ing from the analysis model, or the constraints to be followed to integrate with the legacy systems, should also be depicted. The responsibilities and relationships of the analysis classes should be clarified while an analysis model is introduced.這里要描述軟件系統(tǒng)的總體結(jié)構(gòu)，可以使用結(jié)構(gòu)圖、層次分解圖或包圖來描述，并應(yīng)說明系 統(tǒng)結(jié)構(gòu)劃分的原則（例如，

24、基于標(biāo)準(zhǔn)、協(xié)議所規(guī)定的體系結(jié)構(gòu)，來自于分析模型的方案，或者基 于原有體系結(jié)構(gòu)的限制）。對于使用分析模型的體系結(jié)構(gòu)，應(yīng)說明分析類的職責(zé)及相互關(guān)系。Representation of the Business Flow業(yè)務(wù)流程說明Sequence diagrams or collaboration diagrams could be used to illustrate the specific use case（s） scenarios from the use-case model to represent the final system architecture or analysis c

25、lasses, and how these architectural modules work.描述系統(tǒng)架構(gòu)模塊分析類之間的動態(tài)交互，來說明用例模型中的典型用例場景，以體現(xiàn)系統(tǒng) 功能是如何實(shí)現(xiàn)的。建議采用Sequence圖、Collaboration圖等來描述。Decomposition Description分解描述This section describes the packages, sub-systems, modules in the system. 本節(jié)描述系統(tǒng)中的子系統(tǒng)和模塊。Module/Subsystem 1 Description模塊 1/子系統(tǒng) 1描述Dont actu

26、ally write Module name （1）. Specify the name of the module in few words.不要直接寫“模塊子系統(tǒng)1”，用簡短的詞語命名模塊子系統(tǒng)。Describe as follows按照以下格式描述：Overview 簡介Functions功能列表Module/Subsystem 2 Description模塊2/子系統(tǒng)2描述Dependency Description依賴性描述This section describes the relationships among the design entities such as sub-sy

27、stems, data stores, modules, processes, etc.本節(jié)描述系統(tǒng)中的子系統(tǒng)，數(shù)據(jù)結(jié)構(gòu)，模塊，進(jìn)程等設(shè)計(jì)實(shí)體間的關(guān)系。Structure charts, transaction diagrams could be used to represent dependences.依賴關(guān)系描述可以使用文字，結(jié)構(gòu)圖，（交互）事務(wù)圖。Interface Description接 口描述This section describes the interfaces of the design entities （such as sub-systems, modules, pro

28、cesses, etc.） that make up the system。本節(jié)描述軟件系統(tǒng)中設(shè)計(jì)實(shí)體如子系統(tǒng)，模塊，進(jìn)程的接口.Interface files, parameter tables could be used to describe the interfaces.接口描述可以使用接口文件，參數(shù)表。In case of external entities, only the interfaces relevant to the software being discussed need to be described.對于外部實(shí)體只有同被描述軟件相關(guān)的接口才需描述。Functio

29、n calls、events、messages signals should be included.接口可以是函數(shù)調(diào)用、事件、消息、信號等。Module/Subsystem 1 Interface Description模塊 1/子系統(tǒng) 1 的接口描述Describe as follows對每個接口按照以下格式描述：Name名稱：（The name of the interface接口 名稱）Description 說明：（Brief description of the interface 對接口的簡短說明）Definition定義：（接口原型定義，說明接口類型及相關(guān)參數(shù)）Module/S

30、ubsystem 2 Interface Description模塊2/子系統(tǒng)2的接口描述Level 2 Design Description 第二層設(shè)計(jì)描述Each module that is defined in L1 and identified for further description shall be stated by separate sub-sections as mentioned below. More sub-section levels could be added optionally, and finally all specific classes cor

31、responding to each final minimal module, including its public attributes and pubic methods, should be defined.一層設(shè)計(jì)中定義的每個模塊的進(jìn)一步設(shè)計(jì)在下面的章節(jié)進(jìn)行描述。對層次比較多的模塊，可 以增加設(shè)計(jì)層次，最終要說明對應(yīng)于最小分解模塊的具體設(shè)計(jì)類(包ipiblic 屬性和0刎心方 法)。This will be repeated for each package/module as follows.對每個模塊重復(fù)使用下述的格式。Module Name (1)模塊 1名稱Dont ac

32、tually write Module name (1). Specify the name of the module in few words.不要直接寫“模塊1名稱”，用簡短的詞語命名模塊。如果本文檔是針對增強(qiáng)開知、特性的設(shè)計(jì)，繼承了原有的二層模塊結(jié)構(gòu)，那么應(yīng)拷貝原有的 模塊結(jié)構(gòu)說明，如包圖類圖和相應(yīng)的文字說明，然后在二層設(shè)計(jì)中明顯標(biāo)識出新增功能在原有模 塊結(jié)構(gòu)中的位置(屬于原來哪一個子模/設(shè)計(jì)類的新增功能，與原有各子模搬計(jì)類之間有什么 交互)。在后續(xù)的功能實(shí)現(xiàn)說明和設(shè)計(jì)類定義中，如果與本次增強(qiáng)開小特性無關(guān)的，可以不描 述，如果有關(guān)聯(lián)的，應(yīng)該拷貝原有的設(shè)計(jì)說明，在此基礎(chǔ)上再說明更改的內(nèi)容

33、寸更改的設(shè)計(jì)類 應(yīng)該給出類的完整定義，再標(biāo)識出更改的屬性和方法。Design Description模塊設(shè)計(jì)描述Depict the decomposition of the modules e.g. the functionality of each sub modules. The design classes should be defined here, class diagrams could be used to describe the design classes and the relationships among these classes, and the design

34、 pattern(s) should also be interpreted.描述模塊分解，例如每個子模塊的功能定義。定義出具體的設(shè)計(jì)類，用類圖來描述其相互關(guān) 系，并說明所采用的設(shè)計(jì)模式。This will be repeated for each class as follows.對每個類重復(fù)使用下述的格式進(jìn)行描述。Class namel # 類名Should be replaced by a true design class name.應(yīng)該用實(shí)際的類名替換。Specific classes corresponding to each final minimal module should

35、 be defined as below.按下面的格式對每個設(shè)計(jì)類進(jìn)行說明。CI Identification標(biāo)識CI Identification of the class to be recorded in the Software Requirements Traceability Matrix.說明該類的配置項(xiàng)標(biāo)識用于需求跟蹤，配置項(xiàng)的命名方式Amp中已定義。一般為：產(chǎn)品名_模塊名類名，如果在類的命名中未包括前面兩部分Overview簡介Overview of its responsibilities.簡單介紹該類的功能。Definition類定義(Optional)Class dia

36、grams or pseudo codes could be used to depict the class definitions in detail， if it is not described previously. All the public attributes and methods should be defined specifically.如果該類在前面沒有定義，使用類圖、偽代碼描述該類的類定義，需說明該類的所有昭屬 性和0刎。方法。Class name2 # 類名(1) CI Identification標(biāo)識Overview簡介Definition類定義(Option

37、al)Function Illustration功 能實(shí)現(xiàn)說明Sequence diagrams or collaboration diagrams, etc. could be used to represent the relationships among the design classes and how the design classes implement their typical responsibilities.使用Sequence圖、Collaboration圖等來說明這些設(shè)計(jì)類之間如何交互，實(shí)現(xiàn)本模塊的典型功 能。Module Name (2)模塊2名稱Design

38、Description模塊設(shè)計(jì)描述Class namel # 類名Class name2 # 類名Function皿皿皿/口功能實(shí)現(xiàn)說明Database Design數(shù)據(jù)庫設(shè)計(jì)This section could list all the entities such as data stores (tables, stored procedures (SPs), triggers, etc.); a verbose description of what that entity pertains to and list of all its attributes. For each of th

39、e attributes, its database, the data size, specific constraints and a verbose description of that attribute should be specified. All specific constraints for that entity and its relation ships with other entities should also be noted.本節(jié)列出所有的數(shù)據(jù)存儲類的實(shí)候、存儲過程、觸發(fā)器等，詳細(xì)描述實(shí)體的內(nèi)容和并列出 全部屬性。對每個屬性，詳細(xì)描述其數(shù)據(jù)庫、數(shù)據(jù)大小、特

40、定約束。實(shí)體的所有約束及實(shí)體間的 關(guān)系也要注明。Entities Definition實(shí)體定義Decomposition Description分 解描述Represent the design considerations and constraint rules.The key tables, views and the items, functions, storage requirements, integrity constraints and stress should be defined here. The initial setup data should be consid

41、ered concerning the static tables.闡述設(shè)計(jì)思路及約束規(guī)則。詳細(xì)定義每個關(guān)鍵數(shù)據(jù)表、視圖中的各個字段屬性、存儲要求、完整性約束、功能、注意事 項(xiàng)，對靜態(tài)數(shù)據(jù)表應(yīng)考慮定義初始配置記錄。Internal Dependency Description 內(nèi)部依賴性描述E-R diagrams could be used to depict the relationships between the entities, and the requirements of the storage spaces, performances and integrity should

42、 also be analyzed.使用E-R圖描述實(shí)體間的關(guān)聯(lián)依賴關(guān)系，分析對存取空間、性能、完整性的要求。Behaviors Definitioi行為定義Decomposition Description分 解描述The stored procedures and triggers should be classified according to its functions, etc., and be described in detail and decomposed. The main functions of every sort of SPs or triggers should

43、 also be represented.Recount the functions, input, output, return value, return set, the dependent tables and stored procedures, and special requirements such as transactions.根據(jù)功能或其他方式對存儲過橢蟲發(fā)器進(jìn)行歸類，便于進(jìn)一步細(xì)化和分解，并說明每類存儲 過程/觸發(fā)器主要功能。詳細(xì)定義每個存儲過程觸發(fā)蜀的功能、輸入輸出參數(shù)、返回值、返回的記錄集、依賴的數(shù)據(jù) 表和存儲過程，以及一些特殊要求（比如需要啟用事務(wù)等）。Exter

44、nal Dependency Description外部依賴性描述Represent the dependency with the external modules.描述與其它模塊之間的依賴關(guān)系。Internal Dependency Description 內(nèi)部依賴性描述Represent the dependency between the internal stored procedures, triggers, tables and views.描述存儲過程間、存儲過程和數(shù)據(jù)戮圖間依賴關(guān)系。Detailed Design of Module 模塊詳細(xì)設(shè)計(jì)Class1 CLASS 的設(shè)

45、計(jì)Overview介Recount the responsibilities and functions of the class. Sequence diagrams, collaboration diagrams, or state chart diagrams can be used to depict the realizations, if its not described previously. If necessary, the static and dynamic relationships with the related classes could also be described.如果在前面的設(shè)計(jì)中未說明，則在此詳細(xì)描述DLASS1的職責(zé)和功能，可使用順序圖、協(xié)作 圖、狀態(tài)圖來詳細(xì)描述。必要時，可描述本類與相關(guān)類之間的靜態(tài)態(tài)關(guān)系。Class Diagram類圖Class diagram, if not described in HLD.提供類的結(jié)構(gòu)圖，在概要設(shè)計(jì)中沒有定義時需要。Status Design狀態(tài)設(shè)計(jì)State chart diagr