软件系统设计说明书模板

XX Software System Design Specification(OO)XX 软件系统设计说明书 (OO)版权所有不得复制Copyright © BroadenGate Technologies, Co., Ltd.. All Rights ReservedRevision Record 修订记录Catalog目录1 Introduction 简介 (1)1.1 Purpose 目的 (1)1.2 Scope 范围 (1)1.2.1 Name 软件名称 (1)1.2.2 Functions 软件功能 (1)1.2.3 Applications软件应用 (1)2 Level 0 Design Description第0层设计描述 (1)2.1 Software System Context Definition 软件系统上下文定义 (1)2.2 Design Considerations (Optional)设计思路(可选) (1)2.2.1 Design Alternatives 设计可选方案 (2)2.2.2 Design Constraints 设计约束 (2)2.2.3 Other Design Considerations 其他 (2)3 Level 1 Design Description第一层设计描述 (2)3.1 System Architecture系统结构 (2)3.1.1 Description of the Architecture系统结构描述 (2)3.1.2 Representation of the Business Flow业务流程说明 (3)3.2 Decomposition Description分解描述 (3)3.2.1 Module/Subsystem 1 Description模块1/子系统1描述 (3)3.2.2 Module/Subsystem 2 Description模块2/子系统2描述 (3)3.3 Dependency Description依赖性描述 (3)3.4 Interface Description接口描述 (3)3.4.1 Module/Subsystem 1 Interface Description模块1/子系统1的接口描述 (4)3.4.2 Module/Subsystem 2 Interface Description模块2/子系统2的接口描述 (4)4 Level 2 Design Description第二层设计描述 (4)4.1 Module Name (1) 模块1名称 (4)4.1.1 Design Description模块设计描述 (4)4.1.2 Function Illustration功能实现说明 (5)4.2 Module Name (2) 模块2名称 (5)4.2.1 Design Description模块设计描述 (5)4.2.2 Function Illustration功能实现说明 (5)5 Database Design数据库设计 (5)5.1 Entities Definition实体定义 (6)5.1.1 Decomposition Description分解描述 (6)5.1.2 Internal Dependency Description内部依赖性描述 (6)5.2 Behaviors Definition行为定义 (6)5.2.1 Decomposition Description分解描述 (6)5.2.2 External Dependency Description外部依赖性描述 (6)5.2.3 Internal Dependency Description内部依赖性描述 (6)6 Detailed Design of Module 模块详细设计 (7)6.1 Class1 CLASS的设计 (7)6.1.1 Overview简介 (7)6.1.2 Class Diagram类图 (7)6.1.3 Status Design状态设计 (7)6.1.4 Attributes属性 (7)6.1.5 Methods方法 (7)6.2 Class2 CLASS的设计 (8)7 Detailed Design of the Database数据库详细设计 (8)7.1 Stored Procedure1 #/Trigger1# 存储过程1#/触发器1#的名称 (8)7.2 Stored Procedure 2#/Trigger2# 存储过程2#/触发器2#的名称 (8)Keywords 关键词：Abstract 摘要：List of abbreviations 缩略语清单：<对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。

Describe abbreviations in this document, full spelling of theabbreviation and Chinese explanation should be provided.>1Introduction 简介1.1Purpose 目的This section should state the purpose of this document. The intended reader should also be specified here.这部分要描述文档的目的，并指明文档的读者。

1.2Scope 范围1.2.1 Name 软件名称Identify the software by name.对软件命名。

1.2.2Functions 软件功能Explain what the software product(s) will and will not do (either directly or by reference to another related document).解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）。

1.2.3Applications软件应用Describe the application of the product (either directly or by reference to another software document)描述软件的应用领域（可直接描述也可以参考其他软件文档）。

2Level 0 Design Description第0层设计描述2.1Software System Context Definition 软件系统上下文定义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.本节描述待开发软件系统与外部实体的关系，可以使用系统结构图来描述系统结构和交互关系。

The description of the external 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 Programmer's Manual.外部实体属性描述只限于描述与本系统软件设计相关的属性。

考虑到描述的完整性，可参考相关软件实体文档，如OS程序员手册。

2.2Design Considerations (Optional)设计思路(可选)2.2.1Design Alternatives 设计可选方案Analyze several alternatives of system design scheme, and specify the scheme that shallbeused. 对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案。

2.2.2Design Constraints 设计约束1. Standards compliance 遵循标准Describe standards that software system shall comply with.描述本软件所遵循的标准、规范。

2. Hardware Limitations 硬件限制Describe hardware limitations of the software system.描述本软件系统实现的硬件限制。

3. Technology Limitations 技术限制Describe technology limitations of the software system.描述本软件的技术限制。

2.2.3Other Design Considerations 其他Describe other design considerations of the software system.描述其他有关的设计考虑。

3Level 1 Design Description第一层设计描述3.1System Architecture系统结构如果本文档是针对增强开发/小特性的设计，继承了原有的系统结构，那么应拷贝原有的系统结构说明，如系统结构图和相应的文字说明，然后在一层设计中明显标识出新增功能在原有系统结构中的位置（属于原来哪一个模块的新增功能，与原有各模块之间有什么交互）。

在后续的业务流程说明、模块分解描述、依赖性描述和接口描述中，如果与本次增强开发/小特性无关的，可以不再重复描述，如果有关联的，应该拷贝原有的设计说明，在此基础上再说明更改的内容。

3.1.1 Description of the Architecture系统结构描述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 coming 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.这里要描述软件系统的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明系统结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的方案，或者基于原有体系结构的限制）。