总体设计说明书

1.1   目标和范围

本文档描述XXX产品技术实现的总体性设计。

文档的目的在于：

l     为各功能模块的设计人员提供依据；

l     为编码人员提供依据；

l     为测试人员提供依据；

l     为修改、维护提供条件；

l     项目负责人将按计划书的要求布置和控制开发工作全过程；

l     项目质量保证组将按此计划书做阶段性和总结性的质量验证和确认。

本说明书的预期读者包括：

l     设计人员；

l     开发人员，特别是编码人员；

l     测试人员；

l     软件维护人员；

l     技术管理人员；

l     执行软件质量保证计划的专门人员；

l     参与本项目开发进程各阶段验证、确认以及负责为最后项目验收、鉴定提供相应报告的有关人员。

1.3   定义和缩写

重点是要表明本文档与其它哪些文档是相一致的，可以构成一条基线。

2       系统结构

2.1   物理结构

2.1.1   物理结构图

重点是要表明系统包括多少台机器、设备，以及哪些机器、设备在物理上是相互连接的，并明确系统的物理边界以及与外部元素的交互。

图例

2.1.2   软硬件环境

2.1.2.1  推荐使用的环境

2.1.2.2  系统支持的环境

2.2   逻辑结构

2.2.1   逻辑结构图

重点是要表明系统各机器在逻辑上是否连接，并明确系统的逻辑边界以及与外部元素的交互。

图例

2.3   模块结构

2.3.1   模块列表

2.3.2   模块分布图

重点是要表明各模块怎样分布在各机器上，各模块在逻辑上是否连接，并明确在模块层次上的系统逻辑边界以及与外部元素的交互。

图例

2.3.3   模块结构图

重点是要表明各模块在逻辑上是如何连接的（使用什么接口、协议），并明确在模块层次上的系统逻辑边界以及与外部元素的交互。

图例（包含网络通讯模块的模块逻辑结构图）

图例（在网络通讯模块基础上的模块逻辑结构图）

3       模块

3.1   XXX模块

3.1.1   功能需求

重点是指出模块需要实现什么功能，不需要实现什么功能。注意与需求规格说明书中的功能需求对应，并考虑普遍性的功能需求（强壮性、容错性、安全性）。

3.1.2   性能需求

重点是指出模块需要满足的性能要求。注意与需求规格说明书中的性能需求对应，并考虑普遍性的性能需求（可靠性、稳定性）。

3.1.3   提供的接口

3.1.3.1  接口列表

3.1.3.2  XXX接口

3.1.3.3  XXX接口

3.2   XXX模块

4       协议

4.1   协议列表

4.2   XXX协议

4.2.1   功能需求

重点是指出协议需要实现什么功能，尤其要注意考虑普遍性的功能需求（强壮性、容错性、安全性）。

4.2.2   性能需求

重点是指出协议需要满足的性能要求。这里通常为空，除非有某些特殊的需求。

4.2.3   协议定义

描述消息收发次序和消息格式。或“在《XXX》中定义”

4.3   XXX协议

5       数据库

5.1   表列表

5.2   XXX表

描述表的各字段的含义和定义。或“在《XXX》中定义”

5.3   XXX表

重点是要表明系统的主要功能的实现流程，以模块为最小单位。建议用时序图或协作图表示。