软件系统设计说明书模板

XX Software System Design Specification

(OO)

XX 软件系统设计说明书 (OO)

版权所有不得复制

Copyright © BroadenGate Technologies, Co., Ltd.

. All Rights Reserved

Revision Record 修订记录

Catalog

目录

1Introduction 简介 (6)

1.1Purpose 目的 (6)

1.2Scope 范围 (6)

1.2.1Name 软件名称 (6)

1.2.2Functions 软件功能 (6)

1.2.3Applications软件应用 (6)

2Level 0 Design Description第0层设计描述 (6)

2.1Software System Context Definition 软件系统上下文定义 (6)

2.2Design Considerations (Optional)设计思路(可选) (6)

2.2.1Design Alternatives 设计可选方案 (6)

2.2.2Design Constraints 设计约束 (7)

2.2.3Other Design Considerations 其他 (7)

3Level 1 Design Description第一层设计描述 (7)

3.1System Architecture系统结构 (7)

3.1.1Description of the Architecture系统结构描述 (7)

3.1.2Representation of the Business Flow业务流程说明 (7)

3.2Decomposition Description分解描述 (8)

3.2.1Module/Subsystem 1 Description模块1/子系统1描述 (8)

3.2.2Module/Subsystem 2 Description模块2/子系统2描述 (8)

3.3Dependency Description依赖性描述 (8)

3.4Interface Description接口描述 (8)

3.4.1Module/Subsystem 1 Interface Description模块1/子系统1的接口描述 (8)

3.4.2Module/Subsystem 2 Interface Description模块2/子系统2的接口描述 (8)

4Level 2 Design Description第二层设计描述 (8)

4.1Module Name (1) 模块1名称 (9)

4.1.1Design Description模块设计描述 (9)

4.1.2Function Illustration功能实现说明 (10)

4.2Module Name (2) 模块2名称 (10)

4.2.1Design Description模块设计描述 (10)

4.2.2Function Illustration功能实现说明 (10)

5Database Design数据库设计 (10)

5.1Entities Definition实体定义 (10)

5.1.1Decomposition Description分解描述 (10)

5.1.2Internal Dependency Description内部依赖性描述 (10)

5.2Behaviors Definition行为定义 (11)

5.2.1Decomposition Description分解描述 (11)

5.2.2External Dependency Description外部依赖性描述 (11)

5.2.3Internal Dependency Description内部依赖性描述 (11)

6Detailed Design of Module 模块详细设计 (11)

6.1Class1 CLASS的设计 (11)

6.1.1Overview简介 (11)

6.1.2Class Diagram类图 (11)

6.1.3Status Design状态设计 (11)

6.1.4Attributes属性 (12)

6.1.5Methods方法 (12)

6.2Class2 CLASS的设计 (12)

7Detailed Design of the Database数据库详细设计 (12)

7.1Stored Procedure1 #/Trigger1# 存储过程1#/触发器1#的名称 (13)

7.2Stored Procedure 2#/Trigger2# 存储过程2#/触发器2#的名称 (13)

Keywords 关键词：

Abstract 摘要：

List of abbreviations 缩略语清单：<对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。Describe abbreviations in this document, full spelling of the

abbreviation 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 shall be used. 对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案。

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.

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

This section describes the packages, sub-systems, modules in the system.

本节描述系统中的子系统和模块。

3.2.1Module/Subsystem 1 Description模块1/子系统1描述

Don't actually write "Module name (1)". Specify the name of the module in few words.

不要直接写“模块/子系统1”，用简短的词语命名模块/子系统。

Describe as follows 按照以下格式描述：

1. Overview简介

2. Functions功能列表

3.2.2Module/Subsystem 2 Description模块2/子系统2描述

3.3Dependency Description依赖性描述

This section describes the relationships among the design entities such as sub-systems, data stores, modules, processes, etc.

本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。

Structure charts, transaction diagrams could be used to represent dependences.

依赖关系描述可以使用文字，结构图，（交互）事务图。

3.4Interface Description接口描述

This section describes the interfaces of the design entities (such as sub-systems, modules, processes, etc.) that make up the system。

本节描述软件系统中设计实体(如子系统，模块，进程)的接口.

Interface files, parameter tables could be used to describe the interfaces.

接口描述可以使用接口文件，参数表。

In case of external entities, only the interfaces relevant to the software being d iscussed need to be described.

对于外部实体只有同被描述软件相关的接口才需描述。

Function calls、events、messages、signals should be included.

接口可以是函数调用、事件、消息、信号等。

3.4.1Module/Subsystem 1 Interface Description模块1/子系统1的接口描述

Describe as follows 对每个接口按照以下格式描述：

Name名称：（The name of the interface接口名称）

Description说明：（Brief description of the interface对接口的简短说明）

Definition定义:（接口原型定义，说明接口类型及相关参数）

3.4.2Module/Subsystem 2 Interface Description模块2/子系统2的接口描述

4Level 2 Design Description第二层设计描述

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 corresponding to each final minimal module, including its public attributes and pubic methods, should be defined.

一层设计中定义的每个模块的进一步设计在下面的章节进行描述。对层次比较多的模块，可

以增加设计层次，最终要说明对应于最小分解模块的具体设计类（包括其public属性和public方法）。

This will be repeated for each package/module as follows.

对每个模块重复使用下述的格式。

4.1Module Name (1) 模块1名称

Don't actually write "Module name (1)". Specify the name of the module in few words.

不要直接写“模块1名称”，用简短的词语命名模块。

如果本文档是针对增强开发/小特性的设计，继承了原有的二层模块结构，那么应拷贝原有的模块结构说明，如包图/类图和相应的文字说明，然后在二层设计中明显标识出新增功能在原有模块结构中的位置（属于原来哪一个子模块/设计类的新增功能，与原有各子模块/设计类之间有什么交互）。在后续的功能实现说明和设计类定义中，如果与本次增强开发/小特性无关的，可以不描述，如果有关联的，应该拷贝原有的设计说明，在此基础上再说明更改的内容。对更改的设计类应该给出类的完整定义，再标识出更改的属性和方法。

4.1.1Design Description模块设计描述

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 pattern(s) should also be interpreted.

描述模块分解，例如每个子模块的功能定义。定义出具体的设计类，用类图来描述其相互关系，并说明所采用的设计模式。

This will be repeated for each class as follows.

对每个类重复使用下述的格式进行描述。

1. Class name1 # 类名

Should be replaced by a true design class name.应该用实际的类名替换。

Specific classes corresponding to each final minimal module should be defined as below.

按下面的格式对每个设计类进行说明。

（1）CI Identification标识

CI Identification of the class to be recorded in the Software Requirements Traceability Matrix.

说明该类的配置项标识(用于需求跟踪，配置项的命名方式在CMP中已定义。一般为：产品名_模块名_类名，如果在类的命名中未包括前面两部分)。

（2）Overview简介

Overview of its responsibilities.

简单介绍该类的功能。

（3）Definition类定义（Optional）

Class diagrams 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.

如果该类在前面没有定义，使用类图、伪代码描述该类的类定义，需说明该类的所有public属性和public方法。

2. Class name2 # 类名

（2）Overview简介

（3）Definition类定义（Optional）

4.1.2Function Illustration功能实现说明

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图等来说明这些设计类之间如何交互，实现本模块的典型功能。

4.2Module Name (2) 模块2名称

4.2.1Design Description模块设计描述

1. Class name1 # 类名

2. Class name2 # 类名

4.2.2Function Illustration功能实现说明

5Database Design数据库设计

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 the 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.

本节列出所有的数据存储类的实体(表、存储过程、触发器等)，详细描述实体的内容和并列出全部属性。对每个属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。

5.1Entities Definition实体定义

5.1.1Decomposition 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 considered concerning the static tables.

阐述设计思路及约束规则。

详细定义每个关键数据表、视图中的各个字段属性、存储要求、完整性约束、功能、注意事项，对静态数据表应考虑定义初始配置记录。

5.1.2Internal Dependency Description内部依赖性描述

E-R diagrams could be used to depict the relationships between the entities, and the requirements of the storage spaces, performances and integrity should also be analyzed.

使用E-R图描述实体间的关联依赖关系，分析对存取空间、性能、完整性的要求。

5.2Behaviors Definition行为定义

5.2.1Decomposition 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 also be represented.

Recount the functions, input, output, return value, return set, the dependent tables and stored procedures, and special requirements such as transactions.

根据功能或其他方式对存储过程/触发器进行归类，便于进一步细化和分解，并说明每类存储过程/触发器主要功能。

详细定义每个存储过程(触发器)的功能、输入输出参数、返回值、返回的记录集、依赖的数据表和存储过程，以及一些特殊要求（比如需要启用事务等）。

5.2.2External Dependency Description外部依赖性描述

Represent the dependency with the external modules.

描述与其它模块之间的依赖关系。

5.2.3Internal Dependency Description内部依赖性描述

Represent the dependency between the internal stored procedures, triggers, tables and views.

描述存储过程间、存储过程和数据表/视图间依赖关系。

6Detailed Design of Module 模块详细设计

6.1Class1 CLASS的设计

6.1.1Overview简介

Recount the responsibilities and functions of the class. Sequence diagrams, collaboration diagrams, or state chart diagrams can be used to depict the realizations, if it’s not described previously. If necessary, the static and dynamic relationships with the related classes could also be described.

如果在前面的设计中未说明，则在此详细描述CLASS1的职责和功能，可使用顺序图、协作图、状态图来详细描述。必要时，可描述本类与相关类之间的静态/动态关系。

6.1.2Class Diagram类图

Class diagram, if not described in HLD.

提供类的结构图，在概要设计中没有定义时需要。

6.1.3Status Design状态设计

State chart diagrams can be used to depict the status information of class.

可以用状态图来描述类的状态信息。

6.1.4Attributes属性

可先定义相关的数据结构。也可以不使用表格、而使用伪代码格式描述。

6.1.5Methods方法

Every method should be described.

下面针对每个方法进行说明。

1. Method1# 方法1#的名称

（1）Method Descriptions方法描述

（2）Implementation Descriptions 实现描述

Pseudo codes could be used to depict the method definitions. This is the most important part of LLD.

使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。

2. Method2# 方法2#的名称

6.2Class2 CLASS的设计

7Detailed Design of the Database数据库详细设计Describe the detailed definition of the stored procedures or triggers.

描述存储过程、触发器等的详细实现。

7.1Stored Procedure1 #/Trigger1# 存储过程1#/触发器1#的名称

1. Descriptions 描述

2. Implementation Descriptions 实现描述

Pseudo codes could be used to depict the definitions.

使用伪代码来描述详细实现。

7.2Stored Procedure 2#/Trigger2# 存储过程2#/触发器2#的名称

1. Descriptions 描述

2. Implementation Descriptions 实现描述

Pseudo codes could be used to depict the definitions.

使用伪代码来描述详细实现。