文档内容
项目名称 密级
Project Name Confidentiality Level
仅供收件方查阅
项目编号 版本 文档编号
Project ID Version Document Code
Project ID_SD_001
XX Software System Design
Specification
XX软件系统设计说明书
Prepared by Date yyyy-mm-dd
拟制 日期
Reviewed by Date yyyy-mm-dd
评审人 日期
Approved by Date yyyy-mm-dd
批准 日期
版权所有 不得复制
Copyright © BroadenGate Technologies, Co., Ltd.
. All Rights Reserved
软酷实验室出品-技术文档-3/12/2010-Page 1 of 20 Copyright © BroadenGate
TechnologiesRevision Record
修订记录
Date Revision CR ID /Defect Sec No. Change Description Author
日期 Version ID 修改章 修改描述 作者
修订版本 CR/ Defect号 节
软酷实验室出品-技术文档-8/23/2010-Page 2 of 20 Copyright © BroadenGate
TechnologiesCatalog
目 录
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 High Level Design概要设计..........................................................................................................6
2.1 Level 0 Design Description第0层设计描述.........................................................................7
2.1.1 Software System Context Definition 软件系统上下文定义：..................................7
2.1.2 Design Considerations (Optional)设计思路(可选).....................................................8
2.2 Level 1 Design Description第一层设计描述.......................................................................8
2.2.1 Decomposition Description分解描述.........................................................................9
2.2.2 Dependency Description依赖性描述........................................................................10
2.2.3 Interface Description接口描述..................................................................................11
2.3 Level 2 Design Description （Optional）第二层设计描述（可选）.............................12
2.3.1 Module name (1) 模块1名称.....................................................................................13
2.3.2 Module name (2) 模块2名称.....................................................................................14
2.4 Configuration and Control （Optional）配置和控制（可选）.......................................14
2.4.1 Startup 启动...............................................................................................................14
2.4.2 Closing 关闭..............................................................................................................14
2.4.3 Creating MIB Table Item MIB表项的创建..............................................................14
2.4.4 Deleting MIB Table Item MIB表项的删除..............................................................14
2.4.5 Modifying MIB Table Item MIB表项的更改...........................................................14
2.5 Database （Optional）数据库（可选）...........................................................................15
2.5.1 Entity, Attributes and their relationships 实体、属性及它们之间的关系..............15
2.5.2 E-R diagram 实体关系 图.......................................................................................15
软酷实验室出品-技术文档-8/23/2010-Page 3 of 20 Copyright © BroadenGate
Technologies3 Detailed Design 详细设计............................................................................................................15
3.1 Module 1 Detail Design 模块1详细设计...........................................................................15
3.1.1 Data Description 数据描述......................................................................................16
3.1.2 Function Description 函数描述................................................................................17
3.2 Module 2 Detail Design 模块2详细设计...........................................................................20
3.3 Error Process 错误处理.......................................................................................................20
3.3.1 System Error 系统错误.............................................................................................20
3.3.2 Interface Error 接口错误...........................................................................................20
3.3.3 Protocol Error 协议错误............................................................................................20
软酷实验室出品-技术文档-8/23/2010-Page 4 of 20 Copyright © BroadenGate
TechnologiesKeywords 关键词：软件设计说明书
Abstract 摘 要：本文档表述了XX软件的具体设计
List of abbreviations 缩略语清单：
Abbreviations缩略语 Full spelling 英文全名 Chinese explanation 中文解释
软酷实验室出品-技术文档-8/23/2010-Page 5 of 20 Copyright © BroadenGate
Technologies1 Introduction 简介
1.1 Purpose 目的
This section should state the purpose of this document. The intended reader
should 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软件应用
Describe the application of the product (either directly or by reference to another software
document)
描述软件的应用（可直接描述也可以参考其他软件文档）
2 High Level Design概要设计
2.1 Level 0 Design Description第0层设计描述
软酷实验室出品-技术文档-8/23/2010-Page 6 of 20 Copyright © BroadenGate
Technologies2.1.1 Software System Context Definition 软件系统上下文定义：
Describes the network organizing mode of the software system in actual environment (usually
in drawings).
Describes how the software system forms a functional entity with other external entities
(usually in drawings).
首先描述本软件系统在实际环境的组网方式（一般用图描述）
描述系统如何与外部实体一道组成功能实体（一般用图描述）
This section describes relationships between the software system to be developed and
external entities. Architecture diagram, Top level DFD (Data-Flow-Diagram) or transaction
diagrams can be used to describe architecture and interaction.
本节还要描述待开发软件系统与外部实体的关系.，可以使用系统架构图、顶层数据流
图、事务图等来描述系统结构和交互关系。
All external entities of the software system (defined in Procedure of Design Specification)
that interact with the software system, or affect the software system in a certain mode, for
example, OS, driver, hardware, interrupt or other software systems.
The property (such as message, library invoking) and type (such as OS service,
communication service, system tools, etc.) of the interaction between external entities and this
system. Only the contents that are helpful in the software design should be included while
describing the features of an external entity. Instead of a complete description in this
specification, you can make indexes to refer to the relative documents that describe the software
design. For example, an index can be made for the programming guidance of the OS.
所有系统外围实体(在设计规格流程中有定义)，这些实体与软件系统发生交互作用或
以某种方式影响软件系统，比如，操作系统，驱动程序，硬件，中断，其他软件系统等.
外围实体和本系统相互作用的性质(比如，消息，库调用)和类型(比如，OS服务，通信
服务，系统工具等)。描述外部实体的特性时要注意该描述一定要有助本软件的设计和描述。
为了本文档内容的完整性，可以采用对于描述相关设计实体文档索引的方式：如对于操作
系统编程手册的索引
软酷实验室出品-技术文档-8/23/2010-Page 7 of 20 Copyright © BroadenGate
Technologies2.1.2 Design Considerations (Optional)设计思路(可选)
2.1.2.1 Design Methodology 设计方法
Describe design methodology that shall be used in the software system design.描述本软件系
统所采取的设计方法。
2.1.2.2 Design Alternatives 设计可选方案
Analysis several alternatives of system design scheme, and specify the scheme that shall be
used. 对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案
2.1.2.3 Design 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.描述本软件的技术限制
4. Other Design Considerations 其他
Describe other design considerations of the software system.描述其他有关的设计考虑
2.2 Level 1 Design Description第一层设计描述
Architecture of the software system shall be described here. 这里要描述软件系统的总体结
构。
Structure chart, Hierarchical decomposition diagram, natural language can be used to
represent the architecture.总体结构描述可以使用结构图，层次分解图，自然语言。
2.2.1 Decomposition Description分解描述
2.2.1.1 Module/Subsystem Decomposition模块/子系统分解
软酷实验室出品-技术文档-8/23/2010-Page 8 of 20 Copyright © BroadenGate
TechnologiesThis section describes subsystems ,module in the system..本节描述系统中的子系统和模块。
1. Module/Subsystem 1 Description模块/子系统1描述
Describe as follows 按照以下格式描述：
Identification 标识：
Type 类型：
Purpose目的：
Functions 功能列表：
Sub modules: 子模块：If this module will be further decomposed into sub modules, list all
sub modules here. 如果本模块还要继续划分，列出下属子模块
2.2.1.2 Concurrent Process Decomposition并发进程处理分解
This section describes concurrent processes in the system..本节描述系统中的并发进程。
In case of external entities, Subordinates attribute need not be described. 对于外部实体，从
属属性不必描述。
1. Process 1 Description进程1描述
Describe as follows 按照以下格式描述：
Identification 标识：
Type 类型：
Purpose目的：
Functions 功能列表：
This part describes the functions to be performed in the process. If the function has been
described in module decomposition before, description should be made on what functions of the
modules are implemented in this process.
描述本进程中要完成的功能，如功能已经在前面的模块分解中有描述，则重点描述本
进程完成了哪些模块的哪些功能。
2.2.1.3 Data Decomposition数据分解
This section describes data stores in the system..本节描述系统中的数据结构。
External data entities shall not be described.外部数据实体不必描述。
Describes the global data structure of the system, including: the data directly accessed by
软酷实验室出品-技术文档-8/23/2010-Page 9 of 20 Copyright © BroadenGate
Technologiesdecomposed modules, and the data structure used in interface of decomposed modules. When
describing the data, make sure the data is the global data of the level.
本章节描述本系统中用到的全局数据结构，其中至少包括： 各分解模块直接访问的数
据，被各分解模块用来在接口中使用的结构。描述数据时要注意该数据是否真正为本级模
块分解的公用数据。
1. Data Entity 1 Description数据实体1描述
Describe as follows 按照以下格式描述：
Identification 标识：
Type 类型：
Purpose目的：
2.2.2 Dependency Description依赖性描述
This section describes relationships among the design entities such as subsystems, data
stores, modules, and processes etc..本节描述系统中的子系统，数据结构，模块，进程等设计
实体间的关系。
Structure charts, transaction diagrams, MSC, ER diagram can be used to represent
dependences.依赖关系描述可以使用结构图（交互）事务图，消息序列图, ER图。
2.2.2.1 Running Design 运行设计
This section describes how the modules and the processes of this design level cooperate to
perform the functional requirements of the system. MSC, transaction diagrams, Structure charts
can be used to represent the running procedure. Note: All the functional requirements in SRS
should be covered in the description. For Level 2, Function specification of the module to be
decomposed should be covered.
本章节描述本层设计的各个模块和进程是如何配合完成系统的功能需求. 可以用消息序
列图, (交互)事务图, 结构图等进行描述, 可以按照处理过程进行分节描述, 要注意的是描述
的内容应该涵盖所有SRS文档的功能需求, 对于二级设计来讲, 就是要涵盖分解对象模块的
功能规格
软酷实验室出品-技术文档-8/23/2010-Page 10 of 20 Copyright © BroadenGate
Technologies2.2.2.2 Data Dependencies数据依赖关系
This section describes relationships among data stores。
本节描述数据结构间的关系。
ER diagram can be used to represent dependences.
依赖关系描述可以使用ER图。
2.2.3 Interface Description接口描述
This section describes interfaces of the design entities (such as subsystem, module,
process)that make up the system。
本节描述软件系统中设计实体(如子系统，模块，进程）的接口.
Interface files, parameter tables can be used to describe Interface.
接口描述可以使用接口文件，参数表。
In case of external entities, only the interfaces relevant to the software being described need
be described.
对于外部实体只有同被描述软件相关的接口才需描述。
2.2.3.1 Module/Subsystem Interfaces模块/子系统接口
This section describes interfaces of Module/Subsystem Interfaces。本节描述模块/子系统
的接口。
1. Interfaces Provided by Module/Subsystem 1 模块/子系统1提供的接口
For interface function, following format should be used:
Interface 1:
Format:
Input:
Output:
Return: Describes the return value of the function
Description: Describes the objective of the interface.
对于接口函数，可以采用以下形式描述：
接口1：
形式：
软酷实验室出品-技术文档-8/23/2010-Page 11 of 20 Copyright © BroadenGate
Technologies输入：
输出：
返回：描述返回什么。
描述：总体描述该接口实现的目的。
2.2.3.2 Process Interfaces进程接口
This section describes interfaces of process。本节描述进程的接口。
1. Process 1 Description进程1描述
The interfaces between the processes describe the shared memory, protocol data and
messages, etc.
进程间的接口主要是描述一些共享内存，协议数据，消息等。
Describe as follows 按照以下格式描述：
Identification 标识：
Type 类型：
Purpose目的：
Functions 功能列表：
2.3 Level 2 Design Description （Optional）第二层设计描述（可选）
Each entity that is defined in L1 and identified for further description shall be described by
separate sub-sections as mentioned below.L1中定义的每个实体的进一步设计在下面的章节进
行描述。
This will be repeated for each module as follows (Same as Level 1). The detailed suggestions
are also the same as Level 1.
对每个模块重复使用下述的格式(和一层设计一样)。具体的编写建议参见第一层设计
2.3.1 Module name (1) 模块1名称
2.3.1.1 Decomposition Description 分解描述
1. Module/Subsystem Decomposition模块/子系统分解
1） Module/Subsystem 1 Description模块/子系统1描述
软酷实验室出品-技术文档-8/23/2010-Page 12 of 20 Copyright © BroadenGate
Technologies2） Module/Subsystem 2 Description模块/子系统2描述
******
2. Concurrent Process Decomposition并发进程处理分解
1） Process 1 Description进程1描述
2） Process 2 Description进程2描述
******
3. Data Decomposition 数据分解
1） Data Entity 1 Description 数据实体1描述
2） Data Entity 2 Description 数据实体2描述
******
2.3.1.2 Dependency Description 依赖性描述
1. Running Design 运行设计
2. Data Dependencies数据依赖关系
3. ******
2.3.1.3 Interface Description 接口描述
1. Module/Subsystem Interfaces模块/子系统接口
1） Interfaces Provided by Module/Subsystem 1 模块/子系统1提供的接口
2） Interfaces Provided by Module/Subsystem 2 模块/子系统2提供的接口
******
2. Process Interfaces进程接口
1） Process 1 Description进程1描述
2） Process 1 Description进程1描述
******
2.3.2 Module name (2) 模块2名称
******
2.4 Configuration and Control （Optional）配置和控制（可选）
软酷实验室出品-技术文档-8/23/2010-Page 13 of 20 Copyright © BroadenGate
Technologies2.4.1 Startup 启动
Describes the steps to start up a module
描述启动一个模块的步骤
2.4.2 Closing 关闭
Describes the steps to close a module
描述关闭一个模块的步骤
2.4.3 Creating MIB Table Item MIB表项的创建
Steps to create a new table item. The title of this section can be modified.
创建新表项的动作步骤。该节的标题可以适当更改
2.4.4 Deleting MIB Table Item MIB表项的删除
Steps to delete a table item. The title of this section can be modified.
删除表项的动作步骤. 该节的标题可以适当更改
2.4.5 Modifying MIB Table Item MIB表项的更改
Steps to modify a table item. The title of this section can be modified.
修改表项的动作步骤. 该节的标题可以适当更改。
2.5 Database （Optional）数据库（可选）
2.5.1 Entity, Attributes and their relationships 实体、属性及它们之间的关系
This section could list all the entities such as data stores, 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 relationship with other entities should also be noted.
本节列出所有的数据存储类的实体，详细描述实体的内容和并列出全部属性。对每个
属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注
软酷实验室出品-技术文档-8/23/2010-Page 14 of 20 Copyright © BroadenGate
Technologies明。
2.5.2 E-R diagram 实体关系 图
This section should display the E-R diagram for all the entities listed above.
本节描述关于上节提到的所有实体的E-R图
3 Detailed Design 详细设计
This section should focus on the description of the detailed design of the software entities that
are a part of the software being described by the HLD Specification。.
对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。
3.1 Module 1 Detail Design 模块1详细设计
Describe data that defined or used in the module, including:
Simple data i.e. global variable, constant or macro within the module;
Complex data i.e. Structure or union....
描述模块中定义和使用的数据，包括：
简单数据，如模块级的全局变量、常量、宏；
复合数据，如模块内部的结构、联合...；
3.1.1 Data Description 数据描述
Describe simple variables, constant or macro of the module in sub-section 1;
Describe complex data from sub-section 2, such as structure, union;
在1中描述本模块中的简单变量、常量、宏；
从第2部分起描述本模块中的复合数据，如结构、联合等；
3.1.1.1 Simple Data Description 简单数据描述；
describe simple variables、constant or macro used or defined in this module;
描述在本模块中定义和使用的简单变量、常量、宏；
Describes simple variables, constants used or defined in this module;
软酷实验室出品-技术文档-8/23/2010-Page 15 of 20 Copyright © BroadenGate
TechnologiesThe description of simple data should follow the format below:
Function Description: Describing the usage of the data
Data Definition: Defining the data
按照下列格式进行简单数据的描述
功能描述：描述该数据的用途
数据定义：定义该数据
3.1.1.2 Structure 1 结构1
Define and describe the Data structure (include union)
定义和说明该数据结构(包括联合);
The description of data structure should follow the format below:
Data Structure Description: Describing the usage of the data structure
Data Structure Definition: Defining the data structure with the actual programming
language
Data Items Description:
Data Type Data Item Definition Data Item Description
按照下列格式进行数据结构的描述
数据结构描述：描述该数据结构的用途
数据结构定义：用实际的编程语言定义该数据结构
数据项描述：
数据类型 数据项定义 数据项描述
3.1.1.3 Structure 2 结构2
3.1.2 Function Description 函数描述
软酷实验室出品-技术文档-8/23/2010-Page 16 of 20 Copyright © BroadenGate
TechnologiesThis section should follow the format below:
Identification: Title of the module
Type: Type of the module, for example, the module in Level 2 Design, the process in Level 1
Design, etc.
Function Description: Describing the functions of the module in brief, which should be
consistent with the related section of the HLD documents.
Function Invoking Relation: Using the Hierarchy Chart or Structure Chart to describe it, for
example:
本节应按照下列格式进行描述：
标识：模块名称
类型：模块类型，如，2级设计中的模块，1级设计中的进程
功能概述：简要描述本模块功能，要和概要设计文档中相关模块分解的描述一致。
函数调用关系: 用层次图或结构图的方式描述函数调用关系，如：
Function1
A,B
D,E
C
Function2 Function3
图1 Module 1 Structure Chart 模块 1 结构图
3.1.2.1 Function 1 函数1
Descript the function as follows;
Function: // name of function
Description: // functionality of the function
Calls: // function lists which called by this function
Data Accessed: // global variables or database tables to be visited
Data Updated: // global variables or database tables to be modified
软酷实验室出品-技术文档-8/23/2010-Page 17 of 20 Copyright © BroadenGate
TechnologiesInput: // description of each input parameter,
// including function description、value description，
// and relationships of the parameters
Output: // description of output parameter
Return: // description of return value
Others: // other descriptions
----------------------------------------------------------------------------------------------------
Implement: pseudo code or flow chart can be used here
用以下格式描述函数
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Data Accessed: // 被访问的全局变量和数据库表
Data Updated: // 被修改的全局变量和数据库表
Input: // 输入参数说明，包括每个参数的作用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
----------------------------------------------------------------------------------------------------
实现： 这里可以使用伪码或流程图
例子:
m2ua_return_t m2ua_nif_sendto_mtp2
/*该函数重用原来MTP3模块中提供的向MTP2发消息的函数*/
if 链路号不合法 返回 M2UA_FAILURE，失败
if 消息类型不正确 返回 M2UA_FAILURE ，失败
if 参数指针为空 返回 M2UA_FAILURE ，失败
调用 消息申请函数VOS_AllocMsg，为临时变量pMsg申请消息包空间
if 申请消息包失败 返回 M2UA_FAILURE，消息申请函数
软酷实验室出品-技术文档-8/23/2010-Page 18 of 20 Copyright © BroadenGate
Technologies填写发送模块信息到pMsg
调用 设备管理的函数Dev_FromVspCardNoGetCpuid，填写目的板的CPUID
if 调用失败
调用 VOS_FreeMsg，释放pMsg的消息包空间
返回 M2UA_FAILURE，失败
填写目的功能模块号到pMsg
填上消息包的具体内容
调用 消息发送函数VOS_SendMsg，VOS把消息包发送到给MTP2
返回 M2UA_SUCCESS，成功
3.1.2.2 Function 2 函数2
3.2 Module 2 Detail Design 模块2详细设计
3.3 Error Process 错误处理
3.3.1 System Error 系统错误
Describes how the errors, such as memory allocation failure, task creation failure, to be
processed.
描述象内存分配失败，任务创建失败等错误是如何被处理的。
3.3.2 Interface Error 接口错误
Describes the error codes to be generated for the external entities
描述将要产生并给外部实体用的错误码
3.3.3 Protocol Error 协议错误
Describes how to handle the errors not mentioned in the protocols. (Optional)
软酷实验室出品-技术文档-8/23/2010-Page 19 of 20 Copyright © BroadenGate
Technologies描述在协议中没有描述的情况如何处理。（可选）
软酷实验室出品-技术文档-8/23/2010-Page 20 of 20 Copyright © BroadenGate
Technologies
