软件系统设计说明书模板.docx

《软件系统设计说明书模板.docx》由会员分享，可在线阅读，更多相关《软件系统设计说明书模板.docx（15页珍藏版）》请在得力文库 - 分享文档赚钱的网站上搜索。

1、软件系统设计说明书模板 软件系统设计说明书模板项目名称密级 Project Name Confidentiality Level 仅供收件方查阅 项目编号版本文档编号 Project ID Version Document Code 1.0 Project ID_SD_003 XX Software System Design Specification (OO) XX 软件系统设计说明书 (OO) Prepared by Date 拟制日期 Reviewed by Date 评审人日期 Approved by Date 批准日期 版权所有不得复制 Copyright ? BroadenGat

2、e Technologies, Co., Ltd. . All Rights Reserved 仅供收件方查阅-技术文档-3/12/2022-Page 1 of 13 Copyright ? BroadenGate Technologies Revision Record 修订记录 Date Revision CR ID /Defect Sec No. Change Author Version ID Description 日期修改章节作者 修订版本 CR/ Defect号修改描述 仅供收件方查阅-技术文档-3/12/2022-Page 2 of 13 Copyright ? Broaden

3、Gate Technologies Catalog 目录 1 Introduction 简 介 . . 6 1.1 Purpose 目 的 . . 6 1.2 Scope 范 围 . . (6) 1.2.1 Name 软件名 称 . . (6) 1.2.2 Functions 软件功 能 . . (6) 1.2.3 Applications软件应 用 . . 6 2 Level 0 Design Description第0层设计描 述 (6) 2.1 Software System Context Definition 软件系统上下文定 义 . 6 2.2 Design Considerati

4、ons (Optional)设计思路(可 选) (6) 2.2.1 Design Alternatives 设计可选方 案 . 6 2.2.2 Design Constraints 设计约 束 . . (7) 2.2.3 Other Design Considerations 其 他 (7) 3 Level 1 Design Description第一层设计描 述 (7) 3.1 System Architecture系统结 构 . . (7) 3.1.1 Description of the Architecture系统结构描 述 (7) 3.1.2 Representation of th

5、e Business Flow业务流程说 明 . 7 3.2 Decomposition Description分解描 述 . . 8 3.2.1 Module/Subsystem 1 Description模块1/子系统1描 述 (8) 3.2.2 Module/Subsystem 2 Description模块2/子系统2描 述 . 8 3.3 Dependency Description 依赖性描 述 . . 8 3.4 Interface Description接口描 述 . (8) 3.4.1 Module/Subsystem 1 Interface Description模块1/子

6、系统1的接口 描述 (8) 3.4.2 Module/Subsystem 2 Interface Description模块2/子系统2的接口 描述 . 8 4 Level 2 Design Description第二层设计描 述 (8) 4.1 Module Name (1) 模块1名 称 . . (9) 4.1.1 Design Description模块设计描 述 . 9 4.1.2 Function Illustration功能实现说 明 . 10 4.2 Module Name (2) 模块2名 称 . (10) 4.2.1 Design Description模块设计描 述 . 1

7、0 4.2.2 Function Illustration功能实现说 明 . 10 5 Database Design数据库设 计 . . 10 仅供收件方查阅-技术文档-3/12/2022-Page 3 of 13 Copyright ? BroadenGate Technologies 5.1 Entities Definition实体定 义 . (10) 5.1.1 Decomposition Description分解描 述 (10) 5.1.2 Internal Dependency Description内部依赖性描 述 . 10 5.2 Behaviors Definition行

8、为定 义 . . (11) 5.2.1 Decomposition Description分解描 述 (11) 5.2.2 External Dependency Description外部依赖性描述 (11) 5.2.3 Internal Dependency Description内部依赖性描 述 . 11 6 Detailed Design of Module 模块详细设 计 (11) 6.1 Class1 CLASS的设 计 . . (11) 6.1.1 Overview简 介 . . (11) 6.1.2 Class Diagram类 图 . . (11) 6.1.3 Status

9、Design状态设 计 . . (11) 6.1.4 Attributes属 性 . . (12) 6.1.5 Methods方 法 . . 12 6.2 Class2 CLASS的设 计 . . 12 7 Detailed Design of the Database数据库详细 设计 . 12 7.1 Stored Procedure1 #/Trigger1# 存储过程1#/触发器1#的名 称 . 13 7.2 Stored Procedure 2#/Trigger2# 存储过程2#/触发器2#的名称 (13) 仅供收件方查阅-技术文档-3/12/2022-Page 4 of 13 Copy

10、right ? BroadenGate Technologies Keywords Abstract List of abbreviations Abbreviations Full spelling Chinese explanation 仅供收件方查阅-技术文档-3/12/2022-Page 5 of 13 Copyright ? BroadenGate Technologies 1 Introduction 1.1 Purpose This section should state the purpose of this document. The intended reader sho

11、uld also be specified here. 这部分要描述文档的目的，并指明文档的读者。 1.2 Scope 1.2.1 Name Identify the software by name. 对软件命名。 1.2.2 Functions Explain what the software product(s) will and will not do (either directly or by reference to another related document). 解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）。 1.2.3 Applications

12、Describe the application of the product (either directly or by reference to another software document) 描述软件的应用领域（可直接描述也可以参考其他软件文档）。 2 Level 0 Design Description0 2.1 Software System Context Definition This section should describe the relationships between the software system to be developed and the

13、external entities. Architecture diagrams could be used to describe the architecture and the interactions. 本节描述待开发软件系统与外部实体的关系，可以使用系统结构图来描述系统结构和交互关 系。 The description of the external entities attributes shall be limited to these attributes which will interact with the software design. In lieu of a co

14、mplete description, reference could be made to relevant documentation of the concerned software entity, e.g. OS Programmers Manual. 外部实体属性描述只限于描述与本系统软件设计相关的属性。考虑到描述的完整性，可参考 OS程序员手册。相关软件实体文档，如 2.2 Design Considerations (Optional)() 2.2.1 Design Alternatives 仅供收件方查阅-技术文档-3/12/2022-Page 6 of 13 Copyrig

15、ht ? BroadenGate Technologies Analyze several alternatives of system design scheme, and specify the scheme that shall be used. 对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案。 2.2.2 Design Constraints 1. Standards compliance 遵循标准 Describe standards that software system shall comply with.描述本软件所遵循的标准、规 范。 2. Hardware

16、Limitations 硬件限制 Describe hardware limitations of the software system.描述本软件系统实现的硬件限制。 3. Technology Limitations 技术限制 Describe technology limitations of the software system. 描述本软件的技术限制。2.2.3 Other Design Considerations Describe other design considerations of the software system. 描述其他有关的设计考虑。3 Level 1

17、 Design Description 3.1 System Architecture 如果本文档是针对增强开发/小特性的设计，继承了原有的系统结构，那么应拷贝原有的系统 结构说明，如系统结构图和相应的文字说明，然后在一层设计中明显标识出新增功能在原有系统 结构中的位置（属于原来哪一个模块的新增功能，与原有各模块之间有什么交互）。在后续的业 /小特性无关的，可务流程说明、模块分解描述、依赖性描述和接口描述中，如果与本次增强开发 以不再重复描述，如果有关联的，应该拷贝原有的设计说明，在此基础上再说明更改的内容。 3.1.1 Description of the Architecture The

18、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 coming from the analys

19、is 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. 这里要描述软件系统的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明系 统结构划分的原则（例如，基于标准、协议所规定的体系结构，来自

20、于分析模型的方案，或者基 于原有体系结构的限制）。对于使用分析模型的体系结构，应说明分析类的职责及相互关系。 3.1.2 Representation of the Business Flow 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 classes，and how these architectural modules work. 描述系统架构模块/分析类之间的动态交互，来说明用例模型中的典型用例场景，以体现系统 Sequence图、Collaboration图等来描述。功能是如何实现的。建议采用仅供收件方查阅-技术文档-3/12/2022-Page 7 of 13 Copyright ? BroadenGate Technologies 3.2 Decomposition Description This section describes the packages, sub-systems, modules in the system.