软件开发 软件模块概要设计模版

文档修订控制目录1引言......................................................................................................................................................... - 5 -1.1编写目的 (5)1.2定义 (5)1.3参考资料 (5)2概述......................................................................................................................................................... - 5 -2.1模块的位置和作用 (5)2.2设计目标 (6)2.3设计原则 (7)2.4运行环境 (7)3功能流程 ................................................................................................................................................. - 7 -3.1业务时序图 (7)3.2模块业务流程图 (7)3.3系统数据流图 (7)4模块结构设计 ......................................................................................................................................... - 8 -4.1模块总体结构设计 .. (8)5模块功能设计 ......................................................................................................................................... - 8 -5.1模块功能描述 (8)5.2子模块1（名称）功能说明 (8)5.3子模块2（名称）功能说明 (8)6模块性能设计 ......................................................................................................................................... - 8 -7接口设计 ................................................................................................................................................. - 9 -8数据结构设计 ......................................................................................................................................... - 9 -8.1信号量及全局变量设计 (9)8.2主要数据结构 (10)9兼容性设计 ........................................................................................................................................... - 10 -10热备设计 ........................................................................................................................................... - 10 -11测试点及调试支持信息说明 ........................................................................................................... - 21 -11.1功能测试点 (22)11.2性能测试点 (22)11.3调试支持信息 ................................................................................................... 错误!未定义书签。

12网管命令设计 ................................................................................................................................... - 11 -12.1格式说明 (11)12.2示例 (13)13IPV6的支持 .............................................................................................................. 错误!未定义书签。

14其他设计 ........................................................................................................................................... - 21 -15关键技术和难点 ............................................................................................................................... - 22 -16尚未解决的问题 ............................................................................................................................... - 22 -17资源................................................................................................................................................... - 22 -1 引言1.1 编写目的阐明编写概要设计说明书的目的。

1.2 定义列出本文中所用到的专门术语的定义和缩写词的原意。

1.3 参考资料列出有关的参考资料，如：本项目经核准的计划任务书或合同，上级机关的批文；属于本项目的其他已发表的文件；本文件中各处引用的文件、资料，包括所用到的软件开发标准。

列出这些文件的标题、发表日期、出版单位等。

2 概述2.1 模块的位置和作用说明本模块在整个系统中所处的位置，以文字或结构图的方式描述处于哪个层次，与哪些模块有接口。

说明本模块的整个系统中的作用。

2.2 设计功能目标说明本模块最终要实现的功能目标。

2.3 设计方案描述简要介绍方案。

若有专门的文档，可以用。

AC需要描述如下情况是否满足:1)支持IPV6 。

整机的ACCOMM中，不涉及IPV6，暂时不考虑。

2)支持互联互通3）热备4）跨越NAT5）大性能（含业务上的性能、各个通信模块之间的通信性能）6）支持DEBUG(在线的、细分到个体粒度的细节、自动化测试) 7）编程上需要支持64bit，跨平台代码，大小头8）支持可被监控和拉起9）支持不同种类的AP的混接11）支持license的控制。

12)支持各类标准化的网络模型。

13）是否有利于OEM14）是否支持VR的情况.2.4设计原则描述本模块所采用的设计原则。

2.5 运行环境简要地说明对本模块的运行环境的规定，包括软件和硬件环境。

例如：运行该模块所需的硬件设备的最小配置及当前环境的运行配置。

说明为运行该模块所需要的软件支持，如：操作系统、编译器、通信系统、数据库管理系统、文件管理系统、其他应用软件。

3 流程图3.1 业务时序图说明设备(比如:AC)在整个网络中的业务流程，从而说明在此功能中，设备起什么功能。

3.2 模块业务流程图该流程在设备（AC）内部各个模块的交互的流程。

3.3 系统数据流图说明使用到的数据流图。

特别是研究是否存在多任务（多线程）对数据访问的互斥性的问题。

用流程图、文字说明模块的整体业务流程。

4 模块结构设计4.1 模块总体结构设计用结构图、文字说明模块的划分和模块间的层次关系，以及模块间的调用关系。

4.1.1 子模块1（名称）结构设计（可选）用流程图、文字说明子模块1的层次关系。

4.1.2 子模块2 (名称) 结构设计（可选）用流程图、文字说明子模块2的层次关系。

5 模块功能设计5.1 模块功能描述详细描述模块完成的主要功能。

5.2 子模块1（名称）功能说明详细描述子模块1所完成的功能。

5.3 子模块2（名称）功能说明详细描述子模块2所完成的功能。

6 模块性能设计详细描述模块具有的主要性能指标。

说明模块占用内存的情况。

说明模块的设计容量，及达到设计容量后对系统性能的影响。

设计容量是指设计支持的最大xxx，例如，支持的最大用户数、最大路由条目数、最大过滤策略条数等等。

如果需要创建新的任务，请描述任务优先级、占用的资源、共享数据保护。

7 接口设计若涉及到通信机制，无论是系统间的还是进程（线程），需要采用标准的流程。

如：用户接口（根据实际情况，可用附录详细说明）；外部接口（说明本模块与外界的接口包括软件、硬件的接口，本模块与其他模块的接口）；内部接口（说明本模块内的各子模块间的接口）。

需要描述本模块提供的接口或调用的外部接口所使用的信号量，防止信号量死锁。

8 数据结构设计8.1 信号量及全局变量设计新增信号量的用途，互斥信号量的保护范围等。

如果引用了原有的信号量，也需说明所引用的用途、保护的范围等，特别注意是否会导致死锁。