华为软件概要设计实用模板

XX 概要设计说明书

Prepared by 

XXXX有限公司

Revision Record 修订记录

Date

Table List 表目录

Figure List 图目录

XX High Level Design Specification

XX 概要设计说明书

Keywords 关键词：

Abstract  摘    要：

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

Introduction  简介

1.1Purpose  目的

This section should state the purpose of the document. It could also specify the intended audience. 

这部分要描述文档的目的。应该指明读者。

1.2Scope  范围

1.2.1Name 软件名称

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 software document).

解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）

1.2.3Applications软件应用

Describe the application of the product (either directly or by reference to another software document)

描述软件的应用（可直接描述也可以参考其它软件文档）

2High Level Design概要设计 

2.1Level 0 Design Description第零层设计描述

2.1.1Software 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服务，通信服务，系统工具等)。描述外部实体的特性时要注意该描述一定要有助本软件的设计和描述。 为了本文档内容的完整性，可以采用对于描述相关设计实体文档索引的方式：如对于操作系统编程手册的索引

2.1.2Design Considerations (Optional)设计思路(可选)

2.1.2.1Design Methodology 设计方法

Describe design methodology that shall be used in the software system design.描述本软件系统所采取的设计方法。

2.1.2.2Design Alternatives 设计可选方案

 Analysis several alternatives of system design scheme, and specify the scheme that shall be used. 对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案

2.1.2.3Design Constraints 设计约束

1Standards compliance 遵循标准

Describe standards that software system shall comply with.描述本软件所遵循的标准、规范

2Hardware Limitations 硬件

Describe hardware limitations of the software system.描述本软件系统实现的硬件

3Technology Limitations 技术

Describe technology limitations of the software system.描述本软件的技术

2.1.2.4Other Design Considerations 其它

Describe other design considerations of the software system.描述其它有关的设计考虑

2.2Level 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.1Decomposition Description分解描述

2.2.1.1Module/Subsystem  Decomposition模块/子系统分解

This section describes  subsystems ,module in the system..本节描述系统中的子系统和模块。

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

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

Identification 标识：

Type 类型：

Purpose目的：

Functions 功能列表：

Requirement IDs to implement 要实现的需求ID:

Submodules: 子模块：If this module will be further decomposed into submodules, list all submodules here. 如果本模块还要继续划分，列出下属子模块

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

2.2.1.2Concurrent Process Decomposition并发进程处理分解

This section describes  concurrent  processes  in the system..本节描述系统中的并发进程。

In case of external entities, Subordinates attribute need not be described. 对于外部实体，从属属性不必描述。

1Process 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.

描述本进程中要完成的功能，如功能已经在前面的模块分解中有描述，则重点描述本进程完成了哪些模块的哪些功能。

2Process 2 Description进程2描述

2.2.1.3Data 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 decomposed 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.

本章节描述本系统中用到的全局数据结构，其中至少包括： 各分解模块直接访问的数据，被各分解模块用来在接口中使用的结构。描述数据时要注意该数据是否真正为本级模块分解的公用数据。

1Data Entity 1 Description数据实体1描述

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

Identification 标识：

Type 类型：

Purpose目的：

2Data Entity 2 Description数据实体2描述

2.2.2Dependency 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.1Running 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文档的功能需求, 对于二级设计来讲, 就是要涵盖分解对象模块的功能规格

2.2.2.2Data Dependencies数据依赖关系

This section describes  relationships among  data stores。

本节描述数据结构间的关系。

ER diagram can be used to represent dependences.

依赖关系描述可以使用ER图。

2.2.3Interface 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.1Module/Subsystem Interfaces模块/子系统接口

This section describes  interfaces of  Module/Subsystem Interfaces。本节描述模块/子系统的接口。

1Interfaces 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：

形式：

输入：

输出：

返回：描述返回什么。

描述：总体描述该接口实现的目的。

2Interfaces Provided by Module/Subsystem 2 模块/子系统2提供的接口

2.2.3.2Process Interfaces进程接口

This section describes  interfaces of  process。本节描述进程的接口。

1Process 1 Description进程1描述

The interfaces between the processes describe the shared memory, protocol data and messages, etc.

进程间的接口主要是描述一些共享内存，协议数据，消息等。

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

Identification 标识：

Type 类型：

Purpose目的：

Functions 功能列表：

2Process 2 Description进程2描述

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.1Module name (1) 模块1名称

2.3.1.1Decomposition Description 分解描述

1Module/Subsystem  Decomposition模块/子系统分解

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

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

******

2Concurrent Process Decomposition并发进程处理分解

1）Process 1 Description进程1描述

2）Process 2 Description进程2描述

******

2.3.1.2Data Entity Description数据实体描述

Describe as follows 按照以下格式描述模块内部使用的多个数据实体：

Identification 标识：

Type & structure(if applicable) 类型及组成结构（必要的话）：

Purpose目的：

2.3.1.3Dependency Description  依赖性描述

1Running Design 运行设计

2Data Dependencies数据依赖关系

******

2.3.1.4Interface Description  接口描述

1Module/Subsystem Interfaces模块/子系统接口

1）Interfaces Provided by Module/Subsystem 1 模块/子系统1提供的接口

2）Interfaces Provided by Module/Subsystem 2 模块/子系统2提供的接口

******

2Process Interfaces进程接口

1）Process 1 Description进程1描述

2）Process 1 Description进程1描述

******

2.3.2Module name (2) 模块2名称

******

2.4

Configuration and Control （Optional）配置和控制（可选）

2.4.1Startup 启动 

Describes the steps to start up a module.

描述启动一个模块的步骤

2.4.2Closing 关闭

Describes the steps to close a module.

描述关闭一个模块的步骤

2.4.3Creating MIB Table Item MIB表项的创建

Steps to create a new table item. The title of this section can be modified.

创建新表项的动作步骤。该节的标题可以适当更改

2.4.4Deleting MIB Table Item MIB表项的删除

Steps to delete a table item. The title of this section can be modified.

删除表项的动作步骤. 该节的标题可以适当更改

2.4.5Modifying MIB Table Item MIB表项的更改

Steps to modify a table item. The title of this section can be modified.

修改表项的动作步骤. 该节的标题可以适当更改。

2.5Database （Optional）数据库（可选）

2.5.1Entity, 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.

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

2.5.2E-R diagram  实体关系 图

This section should display the E-R diagram for all the entities listed above. 

本节描述关于上节提到的所有实体的E-R图

List of reference 参考资料清单：

Please list referred literature and related documents, format:

请罗列本文档所参考的有关参考文献和相关文档，格式如下：

Author + book name (or magazine, literature, document) + publishing company (or issue No., volume No., internal documentation ID) + publishing date + start and end page number,

作者＋书名（或杂志、文献、文档）＋出版社（或期号、卷号、公司文档编号）＋出版日期+起止页码

Examples:

例如：

[1]D. B. Leeson, “A Simple Model of Feedback Oscillator Noise Spectrum,” Proc. IEEE, pp329-330, February 1966 （英文文章格式）

[2]D. Wolaver, Phase-Locked Loop Circuit Design, Prentice Hall, New Jersey,1991  （英文书籍格式）

[3]王阳元，奚雪梅等，“薄膜SOI/CMOS SPICE电路模拟”，电子学报，vol.22，No.5，1994  （中文文章格式）

[4]郑筠，《MOS存储系统及技术》，科学出版社，1990  （中文书籍格式）

[5]XXX，SDXXX用户手册 V1.1，基础部文档室，2001/4/26