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

PAGE 文 档 编 制 编写日期 系统主设计师审核 审核日期 项目经理审核 审核日期 技术总工批准 批准日期 文件模板修改纪录表 日期 修改人 修改内容描述 文档修订控制 序号 版本 修订日期 修订概述 修订人 备注 目 录 TOC \o 1-2 \h \z 1 引言 - 1 - 1.1 编写目的 - 1 - 1.2 定义 - 1 - 1.3 参考资料 - 1 - 2 概述 - 1 - 2.1 模块的位置和作用 - 1 - 2.2 设计目标 - 2 - 2.3 设计原则 - 2 - 2.4 运行环境 - 2 - 3 功能流程 - 2 - 3.1 业务时序图 - 2 - 3.2 模块业务流程图 - 2 - 3.3 系统数据流图 - 2 - 4 模块结构设计 - 3 - 4.1 模块总体结构设计 - 3 - 5 模块功能设计 - 3 - 5.1 模块功能描述 - 3 - 5.2 子模块1（名称）功能说明 - 3 - 5.3 子模块2（名称）功能说明 - 3 - 6 模块性能设计 - 4 - 7 接口设计 - 4 - 8 数据结构设计 - 4 - 8.1 信号量及全局变量设计 - 4 - 8.2 主要数据结构 - 5 - 9 兼容性设计 - 5 - 10 热备设计 - 5 - 11 测试点及调试支持信息说明 - 5 - 11.1 功能测试点 - 5 - 11.2 性能测试点 - 6 - 11.3 调试支持信息 - 6 - 12 网管命令设计 - 6 - 12.1 格式说明 - 6 - 12.2 示例 - 8 - 13 IPV6的支持 - 16 - 14 其他设计 - 16 - 15 关键技术和难点 - 16 - 16 尚未解决的问题 - 16 - 17 资源 - 16 -  引言 编写目的 阐明编写概要设计说明书的目的。 定义 列出本文中所用到的专门术语的定义和缩写词的原意。 参考资料 列出有关的参考资料，如： 本项目经核准的计划任务书或合同，上级机关的批文； 属于本项目的其他已发表的文件； 本文件中各处引用的文件、资料，包括所用到的软件开发标准。 列出这些文件的标题、发表日期、出版单位等。 概述 模块的位置和作用 说明本模块在整个系统中所处的位置，以文字或结构图的方式描述处于哪个层次，与哪些模块有接口。 说明本模块的整个系统中的作用。 设计功能目标 说明本模块最终要实现的功能目标。 设计方案描述 简要介绍方案。若有专门的文档，可以用。 AC需要描述如下情况是否满足: 1)支持IPV6 。整机的ACCOMM中，不涉及IPV6，暂时不考虑。 2)支持互联互通 3）热备 4）跨越NAT 5）大性能（含业务上的性能、各个通信模块之间的通信性能） 6）支持DEBUG(在线的、细分到个体粒度的细节、自动化测试) 7）编程上需要支持64bit，跨平台代码，大小头 8）支持可被监控和拉起 9）支持不同种类的AP的混接 11）支持license的控制。 12)支持各类标准化的网络模型。 13）是否有利于OEM 14）是否支持VR的情况. 设计原则 描述本模块所采用的设计原则。 运行环境 简要地说明对本模块的运行环境的规定，包括软件和硬件环境。 例如：运行该模块所需的硬件设备的最小配置及当前环境的运行配置。 说明为运行该模块所需要的软件支持，如：操作系统、编译器、通信系统、数据库管理 系统、文件管理系统、其他应用软件。 流程图 业务时序图 说明设备(比如:AC)在整个网络中的业务流程，从而说明在此功能中，设备起什么功能。 模块业务流程图 该流程在设备（AC）内部各个模块的交互的流程。 系统数据流图 说明使用到的数据流图。特别是研究是否存在多任务（多线程）对数据访问的互斥性的问题。 用流程图、文字说明模块的整体业务流程。 模块结构设计 模块总体结构设计 用结构图、文字说明模块的划分和模块间的层次关系，以及模块间的调用关系。 子模块1（名称）结构设计（可选） 用流程图、文字说明子模块1的层次关系。 子模块2 (名称) 结构设计（可选） 用流程图、文字说明子模块2的层次关系。 模块功能设计 模块功能描述 详细描述模块完成的主要功能。 子模块1（名称）功能说明 详细描述子模块1所完成的功能。 子模块2（名称）功能说明 详细描述子模块2所完成的功能。 模块性能设计 详细描述模块具有的主要性能指标。 说明模块占用内存的情况。 说明模块的设计容量，及达到设计容量后对系统性能的影响。设计容量是指设计支持的