Turbo5848615
范文一：华为软件概要设计模板
华为软件概要设计模板
XX High Level Design Specification
XX 概要设计说明书
Prepared by
拟制 Reviewed by 评审人 Approved by
批准
Name+ID 姓名+工号
Date 日期 Date 日期 Date 日期
yyyy-mm-dd yyyy-mm-dd yyyy-mm-dd
XXXX Co., Ltd. XXXX有限公司
XX High Level Design Specification XX 概要设计说明书
Please input confidentiality level
请输入密级
Revision Record 修订记录
Page 2 , Total 16 第2页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
Catalog 目 录
1 Introduction 简介................................................................................................................. 6
1.1
1.2 Purpose 目的 ................................................................................................................ 6
Scope 范围 ................................................................................................................... 6
Name 软件名称......................................................................................................... 6
Functions 软件功能 .................................................................................................. 6
Applications软件应用................................................................................................ 6 1.2.1 1.2.2 1.2.3
2 High Level Design概要设计.................................................................................................. 6
2.1 Level 0 Design Description第零层设计描述.................................................................... 6
Software System Context Definition 软件系统上下文定义 ......................................... 6
Design Considerations (Optional)设计思路(可选)..................................................... 7 2.1.1 2.1.2
2.2 Level 1 Design Description第一层设计描述.................................................................... 8
Decomposition Description分解描述......................................................................... 8
Dependency Description依赖性描述 ........................................................................ 9
Interface Description接口描述 ................................................................................ 10 2.2.1 2.2.2 2.2.3
2.3 Level 2 Design Description (Optional)第二层设计描述(可选) .............................. 12
Module name (1) 模块1名称 ................................................................................... 12
Module name (2) 模块2名称 ................................................................................... 13 2.3.1 2.3.2
2.4 Configuration and Control (Optional)配置和控制(可选) ....................................... 14
Startup 启动 ........................................................................................................... 14
Closing 关闭 ........................................................................................................... 14
Creating MIB Table Item MIB表项的创建................................................................. 14
Deleting MIB Table Item MIB表项的删除 ................................................................. 14
Modifying MIB Table Item MIB表项的更改 ............................................................... 14 2.4.1 2.4.2 2.4.3 2.4.4 2.4.5
2.5 Database (Optional)数据库(可选) ....................................................................... 14
Entity, Attributes and their relationships 实体、属性及它们之间的关系 .................. 14
E-R diagram 实体关系 图 ...................................................................................... 14 2.5.1 2.5.2
Page 3 , Total 16 第3页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
Table List 表目录
Table1**表 ..................................................................................................错误～未定义书签。
表1 **表 .......................................................................................................错误～未定义书签。
Figure List 图目录
Figure 1**图 ................................................................................................错误～未定义书签。
图 1**图.......................................................................................................错误～未定义书签。
Page 4 , Total 16 第4页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
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.>
Page 5 , Total 16 第5页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level 请输入密级
1
1.1 Introduction 简介 Purpose 目的
This section should state the purpose of the document. It could also specify the intended
audience.
这部分要描述文档的目的。应该指明读者。
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 software document).
解释软件产品将完成或不完成的功能(可以直接描述也可以参考相关文档)
1.2.3 Applications软件应用
Describe the application of the product (either directly or by reference to another software
document)
描述软件的应用(可直接描述也可以参考其它软件文档)
2
2.1 High Level Design概要设计 Level 0 Design Description第零层设计描述
2.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).
首先描述本软件系统在实际环境的组网方式(一般用图描述)
描述系统如何与外部实体一道组成功能实体(一般用图描述)
Page 6 , Total 16 第6页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
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.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.描述本软件所遵循的标准、规范
Page 7 , Total 16 第7页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
2 Hardware Limitations 硬件限制
Describe hardware limitations of the software system.描述本软件系统实现的硬件限制
3 Technology Limitations 技术限制
Describe technology limitations of the software system.描述本软件的技术限制
2.1.2.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模块/子系统分解
This section describes subsystems ,module in the system..本节描述系统中的子系统和模块。
1 Module/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. 如果本模块还要继续划分，列出下属子模块
2 Module/Subsystem 2 Description模块/子系统2描述
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. 对于外部实体，从属属性不必描述。
Page 8 , Total 16 第8页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
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 Process 2 Description进程2描述
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 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.
本章节描述本系统中用到的全局数据结构，其中至少包括: 各分解模块直接访问的数据，
被各分解模块用来在接口中使用的结构。描述数据时要注意该数据是否真正为本级模块分解
的公用数据。
1 Data Entity 1 Description数据实体1描述
Describe as follows 按照以下格式描述:
Identification 标识:
Type 类型:
Purpose目的:
2 Data Entity 2 Description数据实体2描述
2.2.2 Dependency Description依赖性描述
This section describes relationships among the design entities such as subsystems, data stores, modules, and processes etc..本节描述系统中的子系统，数据结构，模块，进程等设计实体间
的关系。
Page 9 , Total 16 第9页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
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.
本章节描述本层设计的各个模块和进程是如何配合完成系统的功能需求. 可以用消息序列
图,
(交互)事务图, 结构图等进行描述, 可以按照处理过程进行分节描述, 要注意的是描述的
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:
Page 10 , Total 16 第10页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level 请输入密级
Input:
Output:
Return: Describes the return value of the function
Description: Describes the objective of the interface.
对于接口函数，可以采用以下形式描述:
接口1:
形式:
输入:
输出:
返回:描述返回什么。
描述:总体描述该接口实现的目的。
2 Interfaces Provided by Module/Subsystem 2 模块/子系统2提供的接口
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.
进程间的接口主要是描述一些共享第11页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level 请输入密级
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描述
2) Module/Subsystem 2 Description模块/子系统2描述
******
2 Concurrent Process Decomposition并发进程处理分解
1) Process 1 Description进程1描述
2) Process 2 Description进程2描述
******
2.3.1.2 Data Entity Description数据实体描述
Describe as follows 按照以下格式描述模块第12页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
2.3.1.3 Dependency Description 依赖性描述
1
2 Running Design 运行设计 Data Dependencies数据依赖关系
******
2.3.1.4 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名称
******
Page 13 , Total 16 第13页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
2.4 Configuration and Control (Optional)配置和控制(可选)
2.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.
本节列出所有的数据存储类的实体，详细描述实体的实体关系 图
This section should display the E-R diagram for all the entities listed above.
Page 14 , Total 16 第14页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
本节描述关于上节提到的所有实体的E-R图
Page 15 , Total 16 第15页，共16页
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level
请输入密级
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
Page 16 , Total 16 第16页，共16页
范文二：华为软件概要设计模板
产品名称Product name 密级Confidentiality level 产品版本Product version Total 16pages 共16页 XX
High Level Design Specification XX 概要设计说明书 Prepared by 拟制 Name+ID 姓名+工号 Date 日期
yyyy-mm-dd Reviewed by 评审人 Date 日期 yyyy-mm-dd Approved by 批准 Date 日期 yyyy-mm-dd
XXXX Co., Ltd. XXXX有限公司 XX High Level Design Specification XX 概要设计说明书 Please input
confidentiality level 请输入密级 Page 2 , Total 16 第2页，共16页 Revision Record 修订记录 Date 日
期 Revisio n Version 修订 版本 CR ID / Defec t ID CR号 Sec No. 修改 章节 Change Description 修改
描述 Author 作者 XX High Level Design Specification XX 概要设计说明书 Please input confidentiality
level 请输入密级 Page 3 , Total 16 第3页，共16页
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 High Level Design概要设计 ..................................................................................................... 6 2.1 Level 0 Design Description第零层设计描述 ....................................................................... 6 2.1.1 Software System Context Definition 软件系统上下文定义 .......................................... 6
2.1.2 Design Considerations (Optional)设计思路(可选) ........................................................ 7
2.2 Level 1 Design Description第一层设计描述 ....................................................................... 8 2.2.1 Decomposition Description分解描述 ............................................................................ 8 2.2.2 Dependency Description依赖性描述 ............................................................................ 9 2.2.3 Interface Description接口描述 .................................................................................... 10 2.3 Level 2 Design Description (Optional)第二层设计描述(可选) ................................ 12
2.3.1 Module name (1) 模块1名称 ....................................................................................... 12 2.3.2 Module name (2) 模块2名称 ....................................................................................... 13 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)数据库(可选) ........................................................................... 14 2.5.1 Entity, Attributes and their relationships 实体、属性及它们之间的关系 .................... 14
2.5.2 E-R diagram 实体关系 图 .......................................................................................... 14
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level 请输入密级
Page 4 , Total 16 第4页，共16页
Table List 表目录
Table1**表 ..................................................................... 错误～未定义书签。错误～未定义书签。
表1 **表 .......................................................................... 错误～未定义书签。错误～未定义书签。
Figure List 图目录
Figure 1**图 ................................................................... 错误～未定义书签。错误～未定义书签。
图 1**图 .......................................................................... 错误～未定义书签。错误～未定义书签。
XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level 请输入密级
Page 5 , Total 16 第5页，共16页
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.> Abbreviations缩略语 Full spelling 英文全名 Chinese explanation 中文解释 XX High Level
Design Specification XX 概要设计说明书 Please input confidentiality level 请输入密级 Page 6 , Total 16
第6页，共16页
1 Introduction 简介
1.1 Purpose 目的 This section should state the purpose of the document. It could also specify the intended audience. 这部分要描述文档的目的。应该指明读者。
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 software 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 第零层设计描述
2.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). 首先描述本软件系统在实际环
境的组网方式(一般用图描述) 描述系统如何与外部实体一道组成功能实体(一般用图描述) XX High Level
Design Specification XX 概要设计说明书 Please input confidentiality level 请输入密级 Page 7 , Total 16
第7页，共16页 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.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.描述本软
件所遵循的标准、规范 XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level 请输入密级 Page 8 , Total 16 第8页，共16页
2 Hardware Limitations 硬件限制 Describe hardware limitations of the software system.描述本软件系统
实现的硬件限制
3 Technology Limitations 技术限制 Describe technology limitations of the software system.描述本软件的
技术限制
2.1.2.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 模块/子系统分解 This section describes subsystems ,module in the system..本节描述系统中的子系统和模 块。
1 Module/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. 如果本模块还要继续划分，列出下属子模块
2 Module/Subsystem 2 Description 模块/子系统2 描述
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. 对于外部实体，从 属属性不必描述。 XX High Level Design Specification XX 概
要设计说明书 Please input confidentiality level 请输入密级 Page 9 , Total 16 第9页，共16页
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 Process 2 Description 进程2 描述
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 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. 本章节描述本系统中用到的全局数据结构，其中至少包括: 各分解模块直接访问
的数据，被 各分解模块用来在接口中使用的结构。描述数据时要注意该数据是否真正为本级模块分解的公
用 数据。
1 Data Entity 1 Description 数据实体1 描述 Describe as follows 按照以下格式描述: Identification 标
识: Type 类型: Purpose目的:
2 Data Entity 2 Description 数据实体2 描述
2.2.2 Dependency Description 依赖性描述 This section describes relationships among the design entities such as subsystems, data stores, modules, and processes etc..本节描述系统中的子系统，数据结构，模
块，进程等设计实 体间的关系。 XX High Level Design Specification XX 概要设计说明书 Please input
confidentiality level 请输入密级 Page 10 , Total 16 第10页，共16页 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文档的功能需求, 对于二级设计来讲, 就是要涵盖分解对象模块的功能规格
2.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: XX High Level Design Specification XX 概要设计说
明书 Please input confidentiality level 请输入密级 Page 11 , Total 16 第11页，共16页 Input: Output:
Return: Describes the return value of the function Description: Describes the objective of the interface. 对
于接口函数，可以采用以下形式描述: 接口1: 形式: 输入: 输出: 返回:描述返回什么。 描述:
总体描述该接口实现的目的。
2 Interfaces Provided by Module/Subsystem 2 模块/子系统2 提供的接口
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 Process 2 Description 进程2 描述 XX High Level Design Specification XX 概要设计说明书 Please input
confidentiality level 请输入密级 Page 12 , Total 16 第12页，共16页
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 描述
2) Module/Subsystem 2 Description 模块/子系统2 描述 ******
2 Concurrent Process Decomposition 并发进程处理分解
1) Process 1 Description 进程1 描述
2) Process 2 Description 进程2 描述 ******
2.3.1.2 Data Entity Description 数据实体描述 Describe as follows 按照以下格式描述模块内部使用的多个
数据实体: Identification 标识: Type & structure(if applicable) 类型及组成结构(必要的话): Purpose
目的: XX High Level Design Specification XX 概要设计说明书 Please input confidentiality level 请输入
密级 Page 13 , Total 16 第13页，共16页
2.3.1.3 Dependency Description 依赖性描述 1 Running Design 运行设计 2 Data Dependencies 数据依
赖关系 ******
2.3.1.4 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 名称 ****** XX High Level Design Specification XX 概要设计说明书
Please input confidentiality level 请输入密级 Page 14 , Total 16 第14页，共16页
2.4 Configuration and Control (Optional)配置和控制(可选)
2.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. 本节列出所有的数据存储类的实体，详细描述实体的内容和并列
出全部属性。对每个属性， 详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也
要注明。
2.5.2 E-R diagram 实体关系 图
范文三：概要设计文档
快乐买网上商城概要设计说明书 0. 导言
本文档主要针对快乐买网上商城系统的总体设计提出要求， 同时它还将作为该产品详细设计与开 发的重要参考依据。
0.1 目的
0.2 范围
本文档包含以下几部分： 1.概述 2.规格说明分析 3.系统体系结构 4.界面设计定义 5.接口定义 6.模块设计 7.数据库设计 8.故障检测和处理机制
0.3 本文档的预期读者 1.设计人员 2.开发人员 3.项目管理人员 4.测试人员 0.4 术语定义
缩写、术语及符号 E-R 图 SSH 界面流 逻辑关系图 Struts,Spring,Hibernate 框架 界面访问流程 解 释
0.5 引用标准
[1]《企业文档格式标准》V1.1 ，XXX 软件有限公司 [2]《概要设计格式标准》V1.1 ，XXX 软件有限公司软件工程过程化组织
0.6 参考资料
[1]《实战 Struts》，Ted Husted，机械工业出版社。 [2]《软件重构》，清华大学出版社。
0.7 版本更新信息
记录文档版本修改的过程，具体版本更新记录如下表所示：
修改编号 SHOE_01 修改日期 2015-2-3 修改后版本 V1.0 修改位置 全部 修改内容概述 初始发布版本
1.
概述
本产品是一套标准的 B2C 电子商城系统，符合市场电子商务规范。本产品遵循《计算机软件保护
条例》的各项规定。建立在互联网标准通信协议之上，其中支持 TCP/IP 协议， 系统采用 B/S 结构， 满足多个用户通过浏览器访问网站信息及购买商品。同时系统通过 JAVA 异常处理机制，事务处理机
制来应对系统出现的错误，另外通过记录日志的方式来记录访问过程及出现的问题。
2.
系统分析
本系统可以实现用户访问网站前台浏览和购买商品，管理员访问网站后台管理商品，用户及订单
信息。 游客可以浏览商品，查看商品信息，但不能添加商品到购物车，不能定制商品和秒杀商品。 游客注册为会员后可以进行购物车管理，定制商品，秒杀商品，订单管理，个人信息管理等一系 列权限。在购物车中允许修改某单个商品购买数量，允许删除商品或清空购物车，允许继续购物和结 算。定制商品是根据用户特定需求来定制鞋子的样式，定制商品不经过购物车。秒杀商品是商家推出 一些特价商品，这些特价商品只在一定时期内有效，用户在有效时间内可以通过抢时间进行秒杀商品， 因为秒杀商品的特殊性，系统规定秒杀成功后的商品不允许取消订单。用户可以根据用户 ID 查看下单 成功的订单，发货途中的订单，取消的订单，退货的订单，交易成功的订单等。用户对个人信息可以 修改基本信息，登录账号信息，收货地址信息等。 系统后台管理员登录系统后台后，可以对系统基本信息进行管理，比如商品管理，企宣管理，评 价管理，订单管理，积分管理，
用户管理，管理员账号管理，交易报表管理，站内信息管理。其中商 品管理是对鞋子品牌、类型、鞋子具体信息进行管理；订单管理是对客户的订单进行查看，发货，处 理退货等。用户管理是对注册用户的信息进行维护。管理员账号管理针对后台系统管理员进行增删及 权限管理。
3.
系统体系结构
根据选用的软件、硬件以及网络环境构造系统的整体框架，划分系统模块，并对系统内各模块之
间的关系进行定义。确定已定义的对象以及其组件在系统内如何传输、通信。如果本系统是用户最终 投入使用的系统的一个子集，或是将要使用现有的一些其他相关系统，在此应对它们各自的功能和相 互之间的关系给予具体的描述。 本产品采用 B/S 三层结构的体系结构，如下图所示
针对 B/S 三层结构，本产品采用目前比较流行的 SSH 整合体系结构框架，如下图所示
4.
界面设计定义
4.1 前台界面流
4.1 后台台界面流
5.
接口定义
（1）人机交互接口 人机交互接口应确定用户采用浏览器同系统交互，包括键盘录入、鼠标操作、Excel 文件输入，按
照有效数据格式输入。主界面使用 iframe 框架，头部页面和尾部页面采用独立页面，方便网站统一风 格和统一信息修改。
（2）网络接口，主要是服务器和网络拓扑图，如下所示：
用户 防火墙 Internate 因特网
路由器 用户
数据库服务器
Web服务器
其他类服务器
手机端
（3）系统与外部接口 主要包括 Excel 文件导入导出， 采用 POI 接口规范。 图片上传采用 commons-io 和 commons-fileupload 规范。 （4）系统内模块之间的接口 本系统采用 SSH 框架实现，其系统模块接口实现如下
（5）数据库接口 数据库接口采用 Hibernate 框架访问数据库，并采用 C3P0 作为连接池。
6.
模块设计
6.1 系统前台功能结构图
快乐买网上商城前台
用户管理
商品管理
购物车管理
特殊购物
订单管理
企业合作
用 户 注 册
用 户 登 录
个 人 信 息 管 理
购 物 车 管 理
个 人 订 单 管 理
商 品 推 荐
商 品 检 索
商 品 列 表
商 品 详 情
商 品 对 比
添 加 到 购 物 车
从 购 物 车 中 删 除
调 整 商 品 数 量
购 生 订 物 秒 直 定 成 单 车 杀 接 购 制 订 支 结 买 单 付 算
订 单 管 理 （ 同 用 户 ）
联 广 盟 告 商 家
6.2 系统后台功能结构图
快乐买网上商城后台 后台管理员登录
用户管理
商品管理
订单管理
物流合作
积分管理
用 户 权 限
用 户 更 改
用 户 查 询
商 品 管 理
品 牌 管 理
类 型 管 理
定 制 鞋 管 理
订 单 查 询
订 单 处 理
订 单 详 情
物 流 合 作 商 管 理
物 流 信 息 管 理
添 加 积 分 秒 杀 商 品
查 看
积 分 秒 杀 商 品
管理员账户
交易报表
企宣设置
站内信息
评价管理
添 加 管 理 员
权 限 管 理
管 理 员 变 更
业 绩 报 表
营 销 报 表
流 量 报 表
合 作 链 接 管 理
广 告 管 理
发 送 公 共 邮 件
客 服 咨 询 回 复
商 品 评 价 管 理
7.
数据库设计
7.1 数据库管理系统选型 本系统使用 MySql5.6 作为数据信息管理数据库，安装在服务器端，客户端通过浏览器发送请求给
T omcat 服务器，Tomcat 服务器接收到请求再访问数据库做相应的 CRUD 操作。 MySQL 是一个关系型数据库管理系统，由瑞典 MySQL AB 公司开发，目前属于 Oracle 公司。 MySQL 最流行的关系型数据库管理系统，在 WEB 应用方面 MySQL 是最好的 RDBMS (Relational Database Management System， 关系数据库管理系统) 应用软件之一。 MySQL 是一种关联数据库管理系 统，关联数据库将数据保存在不同的表中，而不是将所有数据放在一个大仓库内，这样就增加了速度 并提高了灵活性。MySQL 所使用的 SQL 语言是用于访问数据库的最常用标准化语言。MySQL 软件 采用了双授权政策（本词条“授权政策”），它分为社区版和商业版，由于其体积小、速度快、总体
拥有成本低，尤其是开放源码这一特点，一般中小型网站的开发都选择 MySQL 作为网站数据库。 面向会员的客户端系统数据流程图如图所示。
用户
新品推介 热卖推介
新用户注册
用户名密码验证
数据支持
用户信息 数据系统
积分服务
OK
用户登录系统
个人中心 账户服务
购物车服务
商品信息 数据系统
浏览，选定商 品，购买评价
订单及结算 数据系统
面向管理员的系统数据流程图如图所示
管理员
管理员口令 认证
OK
用户管理 订单管理 积分管理 报表管理 站内信息
商品管理 物流合作 管理账户 企宣管理 评价管理
后台数据支持
后台数据系统
7.2
概念结构设计（E-R 图） 1.用户实体
2.鞋子实体
类型ID 鞋子ID 鞋子图片 品牌ID 鞋子编号
购买次数 鞋 现价 内容简介 上市时间 鞋子颜色 生产商 性别
原价
3.订单实体
订单ID 鞋子图片 下单时间 用户ID 订单编号 订单状态
收货电话 订单 快递跟踪 总价
收货地址
4. 管理员实体
管理员账号 管理员ID 管理员密码
管理员
5.广告实体
广告公司 广告链接
广告图片
广告时间 广告收入
广告ID
备注
广告
7.3
逻辑结构设计
依据逻辑关系图，本系统表结构如下 表 1： users 用户 用户表主要用于保存系统用户的资料。 字段名 uid uaccount uname utel ugender upwd uemail uregtime uintegral uinfo upwdask 数据类型 int(10) varchar(50) varchar(50) varchar(50) varchar(10) varchar(50) varchar(50) datetime Float text varchar(50) 能否为空 No No No No No
No No yes Yse Yes Yes 是否主键 Yes 默认值 NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL 用户 描述 ID 自增
用户账号 用户姓名 用户电话 用户密码 用户密码 电子邮箱 注册日期 用户积分 个人简介 密保问题
upwdans udelete uremarks
varchar(50) int(10) varchr(50)
Yes No Yes 表 2：brands 品牌
NULL
密保答案 禁用标识 备注
品牌表主要用于保存鞋类商品所涉及的品牌。 字段名 bid bname bsex bstate bremarks 数据类型 integer varchar(50) varchar(10) int(10) Test 能否为空 No No No No Yes 表 3：types 类型 类型表主要保存鞋类商品的款式类型信息。 字段名 tid tname tremarks tdelete 数据类型 int（10） varchar(50) Text int(10) 表 4：shoes 鞋子 鞋表主要用于保存所经营鞋类商品的商品信息。 字段名 sid tid 数据类型 int(10) int(10) 能否为空 No No 是否主键 Yes NULL 默认值 描述 鞋子 类 ID type 表外键 品牌 ID brands 表外键 鞋子编号 鞋子名称 鞋子价格 鞋库存量 上市时间 生产厂商 性别属性 鞋子颜色 内容简介 卖出次数 鞋子图片 url 鞋子详细 信息 URL 单件鞋总积分 ID 自增 能否为空 No No 是否主键 Yes NULL 默认值 描述 类型 ID 自增 是否主键 Yes NULL 男 0 NULL 默认值 描述 品牌 ID 自增
品牌名称 男鞋、女鞋 是否上线品牌 备注
类型名称 备注 禁用标识
sbid snum sname sprices sdiscount spubtime sproducer sgender scolor sinfo stimessold simage sdetail sintegral
int(10) varchar(50) varchar(50) float float datetime varchar(50) varchar(10) varchar(50) text integer varchar(50) varchar(50) Float
No Yes No No No No Yes No No Yes No Yes Yes Yes
NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL
sdelete sremarks sandroidimg
int(10) text varchar(100)
No Yes Yes 表 5：receives
0 NULL NULL 用户收货地址
鞋禁用标识 备注 手机端图片
用户收货地址主要保存用户配置的物流地址信息。 字段名 recid ruid recprovince reccity recdistrict recstreet rectel recpostcode recmobile recisdefault recreceiver remarks 数据类型 int(10) int(10) varchar(50) varchar(50) varchar(50) varchar(50) varchar(50) int(10) varchar(50) int(10) varchar(50) text 能否为空 No No No No No No No No No No Yes Yes 表 6：orders 订单 订单表主要用于保存用户购买过程中生成的订单信息。 字段名 oid ouid 数据类型 int（10） int（10） 能否为空 No No 是否主键 Yes NULL 默认值 描述 订单 用户 ID ID 自增 是否主键 Yes NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL 默认值 描述 收货地址 ID 用户 ID 自增
User 表外键 收货省份 收货城市 收货地区 收货街道 收货电话 邮政编码 收货手机 是否默认 收货人 备注
users 表外键 收获地址 ID receives 表外键 订单编号 订单状态 下单时间 总 价
orecid onum ostate ordertime ototal oexpinfo ointegral onote
int（10） varchar(5
0) int（10） datetime float varchar(50) varchar(50) text
No No No No No No No Yes
NULL NULL NULL NULL NULL NULL NULL NULL
快递跟踪 总积分 备 注
表 7：order_shoes 订单鞋子尺寸 订单鞋子尺寸表主要用于保存订单内鞋类商品及其相关信息。 字段名 osid o_oid 数据类型 int(10) int(10) 能否为空 No No 是否主键 Yes NULL 默认值 描述 主键 ID 订单 ID 自增
orders 表外键
o_sid ossize osstate osnum oremarks
int(10) float int(10) int(10) text
No No No No Yes 表 8： comments
NULL NULL NULL NULL NULL 鞋子评论
鞋子
ID
shoes 表外键 鞋子大小 鞋子样式 鞋子数量 备注
鞋子评论表主要用于保存鞋类商品所对应的评价信息。 字段名 cid c_uid 数据类型 int(10) int(10) 能否为空 No No 是否主键 Yes NULL 默认值 描述 主键 用户 ID ID 自增
users 表外键 鞋子 ID
c_sid sccomments scscore sctime scoid scremarks
int(10) text int(10) datetime int(10) text
No No No No Yes Yes 表 9：shoe_photos
NULL NULL NULL NULL NULL NULL 鞋子图片
shoes 表外键 评论内容 用户评分 评论时间 从属订单号 备注
鞋子图片表主要用于保存用于展示的鞋类商品的图片。 字段名 spid sp_sid spurl spremarks 数据类型 int（10） int（10） varchar(200) Text 能否为空 No No No Yes 表 10：sizes 尺码 是否主键 Yes NULL NULL NULL 默认值 描述 图片 ID 鞋子 ID 自增
shoes 表外键 图片 URL 备注
尺码表主要保存鞋类商品的尺码信息。 字段名 sizeid sizenum sremarks 数据类型 int(10) float Text 能否为空 No No Yes 是否主键 Yes NULL NULL 默认值 描述 尺寸 ID 自增
尺寸大小 备注
表 11：shoesizes 鞋子尺寸 鞋子尺寸表主要保存鞋类商品和尺寸的对应信息。 字段名 ssid s_sid 数据类型 int(10) int(10) 能否为空 No No 是否主键 Yes NULL 默认值 描述 尺寸 鞋子 ID ID 自增
shoes 表外键 尺码 ID
s_sizeid
int(10)
No
NULL
sizes 表外键
sstate Sremarks scount
int(10) Text int(10) Yes NO 表 12：friend_links
NULL NULL NULL 友情链接
尺寸状态 备注 该尺码鞋子数量
友情链接表主要用于保存合作商户的资料信息。 字段名 flid flname flurl flimage fremarks 数据类型 int(10) varchar(50) varchar(100) varchar(100) text 能否为空 No No No No Yes 表 13：ads 广告 是否主键 Yes NULL NULL NULL NULL 默认值 描述 链接 ID 自增
链接名称 链接 URL 链接图片 备注
广告表主要用于保存企宣广告信息。 字段名 adid adcompany adimage adlink adtimes adincome adremarks 数据类型 int（10） varchar(50) varchar(50) varchar(50) datetime float Text 能否为空 No No No No No No Yes 是否主键 Yes NULL NULL NULL NULL NULL NULL 默认值 描述 广告 ID 广告公司 广告图片 公司链接 到期时间 广告收入 备注 自增
表 14：spcify_shoes 定制鞋 定制鞋表主要保存我们的特色活动个性定制的鞋品。 字段名 spsid sp
_tid 数据类型 int(10) int(10) 能否为空 No No 是否主键 Yes NULL 默认值 描述 定制鞋 ID 类型 ID 自增
types 表外键 品牌 ID
sp_bid spsseq spsname spsprices spscontent spspartnum spspartinfo spsgender spscss spremarks
int(10) varchar(50) varchar(50) Float Text int(10) varchar(50) varchar(10) int(10) Text
No No No No No No No No Yes Yes Yes
NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL
brands 表外键 鞋子编号 鞋子名称 鞋子价格 详细信息 部件数量 部件信息 鞋子性别 定制 CSS 备注
表 15： spcify_results 用户定制结果 用户定制结果主要保存用户完成个性定制以后的各个参数。
字段名 sprid sp_sid
数据类型 int(10) int(10)
能否为空 No No
是否主键 Yes
默认值
描述 定制结果 ID 自增
NULL
定制型号 ID spcify_shoes 表外键 订单 ID
sp_oid sprscheme sprsize sprnum spremarks spstate
int(10) varchar(50) float int(10) Text int(10)
No No No No Yes Yes 表 16：sps_sizes
NULL NULL NULL NULL NULL 1 定制鞋尺寸
orders 表外键 定制方案 结果尺寸 结果数量 备注 定制状态
定制鞋尺寸表主要保存定制鞋的尺寸信息。 字段名 spssid sp_sid 数据类型 int(10) int(10) 能否为空 No No 是否主键 Yes NULL 默认值 描述 定制尺寸 ID 定制 ID spcify_shoes 表外键 尺寸 ID sizes 表外键 尺寸状态 备注 自增
sp_zid spsstate spremarks
int(10) int(10) Text
No No Yes 表 17：second_kills
NULL NULL NULL 秒杀商品
秒杀商品表主要保存参与秒杀活动的商品信息。 字段名 skid sk_sid skintegral skamount skstarttime skduratoin skisvalid sksize skremarks 数据类型 int(10) int(10) Float int(10) datetime datetime int(10) int(10) Text 能否为空 No No No No No No No No Yes 表 18：shoes_inquirys 是否主键 Yes NULL 0 0 NULL NULL 0 NULL NULL 商品咨询 默认值 描述 主键 ID 鞋子 ID shoes 表外键 消耗积分 秒杀数量 秒杀开始时间 秒杀持续时间 秒杀是否过期 秒杀尺码 备注 自增
商品资讯表主要保存关于商品问答的交互信息。 字段名 sqid sq_uid 数据类型 int(10) int(10) 能否为空 No No 是否主键 Yes NULL 默认值 描述 主键 ID 用户 ID users 表外键
sq_sid sqquestion sqanswer sqquestiontime sqanswertime sqremarks
int(10) Text Text datetime datetime Text
No No No No No Yes 表 19：permission 权限表
NULL NULL NULL NULL NULL NULL
鞋子 ID Shoes 表外键 用户资讯问题 客服回复答案 用户提问时间 客服回复时间 备注
权限表主要保存管理员权限类型 字段名 perid pername percont peremarks 数据类型 int(10) varchar(45) varchar(50) text 能否为空 No No Yes Yes NULL NULL 是否主键 Yes 默认值 描述 权限 ID 权限名称 权限内容 权限说明
表 20：percontent 权限详情 权限详情表主要保存各权限角色具体包含哪些权限 字段名 pcid pc_perid pcitems pcmenu pcurl pctnt pcremarks 数据类型 integer integer varchar(45
) varchar(45) varchar(60) varchar(45) text 表 21：admins 管理员 管理员表主要保存系统管理账户。 字段名 aid acount apwd a_pcid aremarks 数据类型 integer varchar(50) varchar(50) int text 能否为空 No No No No NULL 是否主键 Yes 默认值 描述 管理员 ID 管理员账户 管理员密码 管理员权限 permission 外键 备注 能否为空 No No No No NULL NULL NULL 是否主键 Yes 默认值 描述 权限详情 ID 权限编号， permission 外键 具体权限 具体权限菜单页面 具体权限首页地址 说明 备注
8. 故障检测和处理机制
8.1 故障检测机制 系统发生故障采用 log4j 记录日志，将故障写入错误文件 8.2 故障处理机制 系统在业务层采用声明式事务处理，通过事务处理管理异常。
范文四：概要设计文档
概要设计文档
一 引言
1.编写的目的:
用文件的形式，说明对软件系统的设计思路，包括软件系统的组织结构、模块划分、
功能分配、接口设计、程序设计、数据结构设计和出错处理设计等，为程序的详细设计
提供基础。
本说明书的预期的读者:开发人员、维护人员及其他相关人员。
2.背景:
软件名称:简单网络通信
开发单位:雪城软件有限公司
开发者: 张育培
软件用户:(测试软件)
3.定义:
4.参考资料:
a(MSDN中的网络通信SOCKET和数据库操作相关知识。
b(网站中网络通信SOCKET和数据库操作相关知识。
二 任务概述
1.目标:
完成客户端登录到服务器端，并每间隔一定的时间发送一随机数给服务器端，显示
在服务器上，并且存入服务器数据库以供查询。
2.运行环境:
Windows操作系统，安装了SQL2000或更高版本。
3.需求概述:
a(完成客户端登录到服务器，并根据用户的帐户和密码给出相应判断和提示。
b(客户端每次间隔一定的时间向服务器发送一随机数。
c(服务器可以显示当前客户端发来的数据，并可以查询历史客户端发来的随机数。
d(服务器查询可以全部查询，也可以查询指定的一段时间内客户端发来的随机数。
4.条件与限制:
数据库放在服务器端，数据库中存有用户信息表和随机数信息表。 三 总体设计
1.处理流程:
客户端 服务器端
发送用户名——————————————>验证用户名
重新输入用户名<—————————————错误返回“usernameerror”，>
发送密码<——————————————正确返回“usernamerightr”>
发送密码——————————————>验证密码
重新输入密码<—————————————错误返回“userpwderror”，>
登录成功<——————————————正确返回“userpwdrightr”>
发送随机数——————————————>接受随机数并存储
2.总体结构和模块外部设计:
登录模块——发送随机数模块——服务器操作数据库模块
void CClientDlg::OnBnClickedButLog() 登录模块
bool CClientDlg::randonnumsend(void) 发送一个随机数模块
bool CServerDlg::InsertDataBase(char * numv)向数据库插入客户端送来的随机数
void CServerDlg::OnBnClickedButQuery() 响应查询模块
3.功能分配:
客户端:
发送用户名和密码给服务器，并在登录之后间隔3秒产生一随机数发送给服务器。
服务器:
验证用户名和密码;接受客户端送来的随机数;将随机数存入数据库;查询数据库。 四 接口设计
1.外部接口
2.内部接口
客户端
void CClientDlg::OnBnClickedButLog() 响应登录按钮
bool CClientDlg::LinkServer(void) 连接数据库
LRESULT CClientDlg::OnSelect(WPARAM wparam,LPARAM lparam)异步消息映射
bool CClientDlg::recvtext(void) 接受消息
bool CClientDlg::sendtext(void) 发送消息
bool CClientDlg::randonnumsend(void) 发送一个随机数
void CClientDlg::OnTimer(UINT_PTR nIDEvent) 响应计时器
服务器端
void CServerDlg::OnBnClickedButExit() 响应退出按钮
void CServerDlg::OnBnClickedButStart() 响应启动服务器按钮
void CServerDlg::OnBnClickedButQuery() 响应查询按钮
bool CServerDlg::recvtext()接受消息
bool CServerDlg::sendtext()发送消息
bool CServerDlg::checkusername(char * username)验证用户名
bool CServerDlg::linkDB(void)连接数据库
bool CServerDlg::CloseDB(void)关闭数据库
bool CServerDlg::checkuserpwd(char * userpwd)验证密码
bool CServerDlg::InsertDataBase(char * numv)向数据库插入客户端送来的随机数
LRESULT CServerDlg::OnSelect(WPARAM wparam,LPARAM lparam)消息映射 五 数据库设计
1.逻辑结构设计
SQL数据库:CSData
两个表:userinfo和insertinfo，分别用来存储用户信息和客户端发送到服务器
的随机数信息。
userinfo表中字段名:id 用于唯一标识一个用户;username 用于存放用户的账户
名; userpwd:用于存放用户的密码
insertifo表中字段名:id用于唯一标识一个随机数;num 用于存储客户端发送过去
的随机数;inserttime 用于存储客户端发送随机数的时间。
2.物理结构设计
数据库文件和数据日志:放在软件同级目录下的DB文件夹中。
3.数据库与程序的关系
用于服务器端验证客户端送来的用户帐户和密码，存放客户端发送来的随机
数，以供服务器端的全部查询和按时间间隔查询。
六 运行设计
1.运行模块的组合
2.运行控制
先开启服务器端，再开启客户端登录。
3.运行时间
每隔3秒，发送一个数据给服务器。知道取消关闭客户端，停止发送。 七 出错处理
1.出错输出信息:
客户端:
a.服务器没有开启，弹出对话框提示用户“连接失败，可能是服务器没有开启～”
b(用户输入用户名错误:弹出对话框提示用户“请确认你的用户名～”，并清
空用户名输入框，且定位到该处。
c(用户输入密码错误:弹出对话框提示用户“请确认你的密码～”，并清空用
户密码输入框，且定位到该处。
d(信息发送失败:弹出对话框提示用户“信息发送失败～”。
e(信息接受失败:弹出对话框提示用户“信息接受失败～”。
服务器端:
a.查询不成功:弹出对话框提示用户“信息查询失败，确认数据库开启～”
b.信息发送失败:弹出对话框提示用户“信息发送失败～”
c.信息接受失败:弹出对话框提示用户“信息接受失败～”。
2.出错处理对策:
出现死等无反应状态，服务器重启。
八 安全保密设计
将用户的帐户和密码信息都存储在服务器端，确认帐户和确认密码分开。 九 维护设计
数据库操作模块维护，网络通信IP更改维护
范文五：概要设计文档
学生课程及成绩管理系统
概要设计
V 1.0
项目经理： 张宝磊 项目负责人：张永锋
评 审 日 期： 2011年11月05日
目 录
1. 导言 . ...................................................................................................................................................... 2 1.1目的 . ............................................................................................................................................... 2 1.2范围 . ............................................................................................................................................... 2 1.3缩写说明 . ....................................................................................................................................... 2 1.4术语定义 . ....................................................................................................................................... 3 1.5引用标准 . ....................................................................................................................................... 3 1.6参考资料 . ....................................................................................................................................... 3 2. 系统分析 . .............................................................................................................................................. 3 3. 界面设计 . .............................................................................................................................................. 4 3.1管理员用户界面功能设计 . ........................................................................................................... 4 3.2教师界面功能设计 . ....................................................................................................................... 5 3.3学生界面功能设计 . ....................................................................................................................... 5 3.4页面功能流程设计 . ....................................................................................................................... 5 4. 体系结构 . .............................................................................................................................................. 6 4.1体系结构 . ....................................................................................................................................... 7
4.1.1 Struts体系结构 . ................................................................................................................ 7 4.1.2系统体系结构 . ...................................................................................................................... 7 4.2系统运行环境 . ............................................................................................................................... 8 4.2.1网络结构图 . .......................................................................................................................... 8 4.2.2 硬件环境 . ............................................................................................................................. 8 4.2.3系统运行的软件环境 . ................................................................................................................ 9
5. 数据模型 . ............................................................................................................................................. 9 5.1数据库的概念结构模型设计 . ....................................................................................................... 9 5.2数据库的逻辑结构模型设计 . ..................................................................................................... 10 5.3数据库物理结构模型设计 . ......................................................................................................... 12 6. 模块设计 . ............................................................................................................................................ 12 6.1管理员模块设计 . ......................................................................................................................... 14
6.1.1表示层设计 . ........................................................................................................................ 14 6.1.2控制层设计 . ........................................................................................................................ 15 6.1.3模型层设计 . .......................................................................................................................... 15 6.2教师信息管理模块设计 . ............................................................................................................. 16 6.2.1表示层设计 . ........................................................................................................................ 16 6.2.2控制层设计 . .......................................................................................................................... 16 6.2.3模型层设计 . .......................................................................................................................... 17 6.3学生信息管理模块设计 . ............................................................................................................. 17 6.3.1表示层设计 . ........................................................................................................................ 17 6.3.2控制层设计 . ........................................................................................................................ 18 6.3.3模型层设计 . ........................................................................................................................ 18
1. 导言
1.1目的
该文档的目的是描述学生课程及成绩管理系统的概要设计，其主要内容包括： ● 系统功能简介 ● 系统结构设计 ● 系统接口设计 ● 数据设计 ● 模块设计 ● 界面设计
本文档的预期的读者是： ● 开发人员 ● 项目管理人员 ● 测试人员
1.2范围
该文档定义了系统的结构和单元接口，但未确定单元的实现方法，这部分内容将在详细设计中实现确定。
1.3缩写说明
JSP
Java Server Page（Java 服务器页面）的缩写，一个脚本化的语言。 EJB
Ｅｎｔｅｒｐｒｉｓｅ Ｊａｖａ Ｂｅａｎ（企业级ＪａｖａＢｅａｎ）的缩写。
JPA
Java Persistence API(Java持久化API) 的缩写。 MVC
Ｍｏｄｅｌ－Ｖｉｅｗ－Ｃｏｎｔｒｏｌ（模式－视图－控制）的缩写，表示一个三层的结构体系。
1.4术语定义
JavaBean
用Java 语言实现的满足一定功能的类。
Hibernate
是一种Java 语言下的对象关系映射框架。
Structs
Structs 最早是作为Apache Jakarta 项目的组成部分，项目的创立者希望通过对该项目的研究，改进和提高JavaServer Pages 、Servlet 、标签库以及面向对象的技术水准。
1.5引用标准
[1] 《软件概要设计报告格式标准》
北京长江软件有限公司软件工程过程化组织
1.6参考资料
[1] 《软件工程案例教程》，韩万江，机械工业出版社 [2] 《Java EE 企业级架构开发技术与案例教程》，杨树林，机械工业出版社
2. 系统分析
本系统实现学生课程及成绩的管理，管理员可以实现对课程和班级信息的增删改操作，同时对学生和教师的基本信息也具有增删改及查看操作；普通用户包括两类，教师可以实现的操作有查看和修改本人基本信息，查看并选择所选课的学生，同时可以给出所选课学生的成绩；学生则有查看和选择课程、查看所选课程的成绩和修改本人信息的权限。
该系统可以方便学校对所开设课程的管理，同时也可以方便教师和学生更好了解课程和成绩信息，提高工作效率和工作质量。
本系统的系统结构如图2-1：
图2-1 系统结构图
3. 界面设计
本系统用户登录界面相同，只是在登录前需对用户类型进行选择。
3.1管理员用户界面功能设计
管理员用户主要实现教师、学生、班级和课程的基本信息管理，主要界面设计如下：
登录页面
选择用户类型为管理员，然后通过用户名和密码实现用户登录，进入管理页面。
教师管理页面
管理员对教师的信息进行查看、添加、删除和修改。 学生管理页面
管理员对学生的信息进行查看、添加、删除和修改。 课程管理页面
管理员对课程信息进行查看、添加、删除和修改。 班级管理页面
管理员对班级信息进行查看、添加、删除和修改。
3.2教师界面功能设计
教师主要实现选择选课学生、成绩录入，主要界面设计如下：
登录页面
选择用户类型为教师，然后通过用户名和密码实现用户登录，进入所对应页面。
选择学生页面
查看选课学生并对所选课的学生进行选择。 公布成绩页面
对学生成绩的录入及公布。
3.3学生界面功能设计
学生主要可以实现对课程进行选择，查看所学课程的成绩和对本人基本信息的修改，主要界面设计如下： 登录页面
选择用户类型为学生，然后通过用户名和密码实现用户登录，进入所对应页面。
选修课程页面
对所开课程进行查看和选择。 查看成绩页面
对所选课程的成绩进行查看。 更改个人信息页面
对本人基本信息进行查看和修改。
3.4页面功能流程设计
具体页面功能流程如下图3-1所示：
图3-1：页面流程
4. 体系结构
系统的总体结构设计遵循如下原则：
１）系统应具有良好的适应性：能适应用户对系统的软件环境、管理内容、模式和界面
的要求；
２）系统应具有可靠性：采用成熟的技术方法和软件开发平台，以保证在以后的实际应
用中安全、可靠；
３）系统应具有较好的安全性：应提高完善的安全机制和用户权限限制机制，确保数据
的受限访问；
４）系统应具有良好的可维护性：系统应易于维护、安装；
５）系统应具有良好的可扩展性：系统应适应未来信息化建设的要求，能方便得进行功
能扩展，以建立完善的信息集成管理体系。
本系统采用struts 体系结构，Struts 最早是作为Apache Jakarta项目的组成部分，项目的创立者希望通过对该项目的研究，改进和提高JavaServer Pages 、Servlet 、标签库以及面向对象的技术水准。软件工程师使用Struts 为业务应用的每一层提供支持。它的目的是为了帮助我们减少在运用MVC 设计模型来开发Web 应用的时间。我们仍然需要学习和应用该架构，不过它将可以完成其中一些繁重的工作。如果想混合使用Servlets 和JSP 的优点来建立可扩展的应用，Struts 是一个不错的选择。
4.1体系结构
目前软件项目中有很多的体系结构，其中struts 和hibernate 是比较流行的体系结构。
4.1.1 Struts体系结构
Struts 的MVC 架构实现：Struts 是Apache 组织的一个开放源码项目。Struts 是一个比较好的MVC 框架，提供了对开发MVC 系统的底层支持，它采用的主要技术是Servlet ，JSP 和Custom tag library。在Struts 框架中Controller 功能由ActionServlet 和
ActionMapping 对象构成，核心是一个Servlet 类型的对象ActionServlet ，它用来接受客户端的请求。ActionServlet 包括一组基于配置的ActionMapping 对象，每个ActionMapping 对象实现了一个请求到一个具体的Model 部分中Action 处理器对象之间的映射。
4.1.2系统体系结构
根据系统分析结果，该系统从结构上应满足：
● 基于浏览器进行显示以方便用户使用；
● 采用MVC 的三层体系结构，分化各个功能组件；
● 采用Hibernate JPA技术与数据库通讯以便于数据库的转换； ● 采用标签技术完成动态页面的简单逻辑。
本系统的体系结构如图4-2，它基本遵循了struts 体系的MVC 框架规范。
图4-2：系统的体系结构
其中：
表示层：用于与用户进行交互以及显示结果。包括所有的JSP ，提供用户界面，接受用户输
入， 还包括相应的ActionFrom Bean，用来存放表单数据，并进行表单数据验证。 控制层：包括所有的Action 类，它完成三项任务：一是进行业务逻辑验证，二是调用模型
组件，三是决定将合适的视图组件返回给用户。
模型：进行逻辑处理的JavaBean 等。数据库采用ODBC 技术以提供数据库的可移植性
客户层主要是指用户登录的Web 浏览器；中间层负责平台的业务逻辑处理和表示逻辑生成；服务层提供底层的信息数据库服务器。
4.2系统运行环境
系统运行的网络结构图、硬件软件环境图如下。
4.2.1网络结构图
本系统的网络拓构图如图4-3：
图4-3：系统的网络拓扑图
其中的局域网用户机主要是学校内部的人员可以使用的机器，远程用户机主要是指通过互联网登录系统的人员使用的机器，可以是学校内部的人，也可以是教师和管理员在外面使用。
4.2.2 硬件环境
本系统的硬件环境如下：
<1>客户机：普通PC
CPU ：Intel Croe2 1.4GHz以上 内存：512MB 以上 能够运行IE7.0以上
分辨率：推荐使用1024*768像素 <2>Web服务器
CPU ：P4 3.0GHz 内存：4GB 以上 硬盘：1T 以上 网卡：KMb/s速度 <3>数据库服务器 CPU ：P4 3.0GHz 内存：4GB 硬盘：1T 以上
4.2.3系统运行的软件环境
本系统的软件环境如下：
操作系统：UNIX 、Linux 、Windows XP或以上版本 数 据 库： MySQL
开发工具包：JDK Version 1.7.0 Web服务器：Tomcat 浏 览 器： IE7.0以上
5. 数据模型
本系统的数据模型主要是进行数据库的设计。
5.1数据库的概念结构模型设计
概念设计以反映现实世界中的实体、属性和它们之间的关系等的原始数据形式，建立数据库的每一幅用户视图。图5-1是系统E-R 图。其中系统中的
图5-1：系统的Ｅ－Ｒ图
5.2数据库的逻辑结构模型设计
数据库的逻辑设计是将各局部的E-R 图进行分解、合并后重新组织起来形成数据库全局逻辑结构，包括所确定的关键字和属性、重新确定的记录结构、所建立的各个数据之间的相互关系。根据本系统需求分析, 系统的数据库包括了管理员信息表、教师信息表、学生信息表、成绩信息表、课程信息表、学生成绩表、课程表以及用户表。 管理员信息表(admin)包括的数据字段： ● id －管理员编号 ● name －姓名 ● password －密码
教师信息表(teacher)包括的数据字段： ● id －教师号 ● name －姓名 ● password －密码 ● title －职称
学生信息表（student ）包括的数据字段： ● id －学号 ● name －姓名
● password －密码 ● jiguan －籍贯 ● department －系别 ● sex －性别 ● mark －学分 ● tel －电话 ● phone －手机 ● email －邮箱地址
班级信息表（classes ）包括的数据字段： ● id －班号
● tea_id－教师号 ● cour_id－课程号 ● room_id－教室编号 ● cour_time－上课时间
课程信息表（course ）包括的数据字段： ● id －课程号 ● name －课程名 ● mark －学分
● prepare －预修课 ● dep －系别
学生成绩表(enrol)包括的数据字段： ● class_id－班号 ● stu_id－学号 ● accept －接受 ● score －成绩
表5-1是对表admin 的设计。
表5-3是对表student 的设计。 表5-3：student （学生信息表）表
表5－4是对表classes 的设计。 表5－4：classes （班级信息表）表
表6－5是对表course 的设计。 表6－5：course （课程信息表）表
表6－6是对表enrol 的设计。 表6－6：enrol （成绩信息表）表 5.3数据库物理结构模型设计
信息存储结构的设计在系统的设计中至关重要，要考虑到数据冗余、系统执行效率、信息控制以及维护等方面的要求。信息的管理离不开数据库的支持，我们采用MySQL 数据库管理系统。
6. 模块设计
按照功能分解，本系统分为用户管理系统和管理员系统。根据页面流程的设计，管理员
系统又分为教师信息管理、学生信息管理、课程管理、班级管理等4个模块，如图6-1。
用户系统又可以分为教师和学生用户系统，教师管理又分为选择学生管理和成绩录入及公布管理，如图6-2：
图6-1：管理员模块
图6-2：教师模块
学生管理又分为选课管理、修改个人信息和查看成绩，如图6-3：
图6-3：学生模块
针对不同用户，提供了三类功能登录接口：即学生登录接口、教师登录接口、管理员登录接口，这些接口都以WEB 页面的形式提供。通过所选用户类型，学生、教师和管理员可以从事各自的活动。
以下将分小节对各个部分进行设计。
6.1管理员模块设计
在该系统中不同的用户有不同的权限，但是对于权限的分配是无法修改的，比如像学生，他只有学生的权限，他不可能具有老师或是管理员的权限，如果具有那将打乱教学计划，所以这个系统不具有权限修改的功能。管理员只可以对学生、教师、课程及班级进行增删改等操作，但是对成绩没有修改的权限。
6.1.1表示层设计
根据上述的功能介绍，总结出管理员功能的页面如表6-1。
图6-4：用户管理页面之间的关系图
6.1.2控制层设计
管理员操作的控制层主要负责进入各个操作界面来对学生、教师、课程、班级的信息进行增删改等事件的流程控制，即设计管理的Ａｃｔｉｏｎ。表6-2列出了管理的每个Action 的入口（即调用Action 的组件）、传递Action 的出口（即Action 将请求转发到目标组件）。
6.1.3模型层设计
用户管理的模型层主要是完成用户信息的浏览、增加用户信息、用户信息维护等业务逻辑，并于完成相应的数据库操作。模型组件见表6-3。
6.2教师信息管理模块设计
用户（教师）模块，教师可以对选课学生进行是否接受操作，并且可以对所接受的学生进行课程打分及公布成绩的操纵
6.2.1表示层设计
根据上述的功能介绍，总结出教师管理模块功能的页面设计如表6-4所示。
各个界面流的基本流程关系图6-5所示。
图6-5：课程管理的页面流程图
6.2.2控制层设计
课程管理的控制层主要负责进入课程管理页面、进入增加课程信息页面、
进入删除课程信息页面、进入修改课程信息页面和进入查询课程信息页面等事件的流程控制。表6-5列出了题库管理控制层每个Action 的入口（即调用Action 的组件）、传递Action 的出口（即Action 将请求转发到目标组件）。 表6-5：控制处理层
6.2.3模型层设计
教师管理的模型层主要是完成用户信息的浏览、用户信息维护等业务逻辑，并于完成相应的数据库操作。模型组件见表6-6。
表6-6：题库模块的模型组件
6.3学生信息管理模块设计
用户（学生）信息管理模块，是学生对个人信息的维护和对课程信息的操作及课程成绩的浏览功能。
6.3.1表示层设计
根据上述的功能介绍，学生管理模块功能的页面如表6-7所示。
各个界面基本流程图如图6-6所示。
图6-6：学生信息管理的页面流程图示
6.3.2控制层设计
学生信息管理控制层主要负责进入学生详细信息管理页面、进入修改学生信息页面。表6-8列出了学生信息管理控制层每个Action 的入口（即调用Action 的组件）、传递Action 的出口（即Action 将请求转发到目标组件）。
6.3.3模型层设计
学生信息管理的业务逻辑主要是完成学生信息的维护，并完成相应数据库的操作。学生信息管理的模型层主要是建立封装了学生信息的bean ，以及封装了数据库操作的组件。模型组件见表6-9。
表6-9学生信息管理模块的模型组件
转载请注明出处范文大全网 » 华为软件概要设计模板
