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

1、文档编制编写日期系统主设计师审核审核日期项目经理审核审核日期技术总工批准批准日期文件模板修改纪录表日期修改人修改内容描述文档修订控制序号版本修订日期修订概述修订人备注1 引言 - 5 -1.1 编写目的 -51.2 定义 -51.3 参考资料 -52 概述 - 5 -2.1 模块的位置和作用 -52.2 设计目标 -62.3 设计原则 -72.4 运行环境 -73 功能流程 - 7 -3.1 业务时序图 -73.2 模块业务流程图 -73.3 系统数据流图 -74 模块结构设计- 8 -4.1 模块总体结构设计 -85 模块功能设计- 8 -5.1 模块功能描述 -85.2 子模块1 （名称）

2、功能说明 -85.3 子模块2 （名称）功能说明 -86 模块性能设计- 8 -7 接口设计 - 9 -8 数据结构设计- 9 -8.1 信号量及全局变量设计 -98.2 主要数据结构 - 109 兼容性设计- 10 -10 热备设计 - 10 -11 测试点及调试支持信息说明 - 21 -11.1 功能测试点 -2211.2 性能测试点 -2211.3 调试支持信息 错误!未定义书签。12 网管命令设计- 11 -12.1 格式说明 - 11 -12.2 示例 - 13-13 IPV6 的支持 错误!未定义书签。14其他设计 -21-15关键技术和难点 -22-16尚未解决的问题 -22-1

3、7 资源 -22 -1 引言1.1 编写目的阐明编写概要设计说明书的目的。1.2 定义列出本文中所用到的专门术语的定义和缩写词的原意。1.3 参考资料列出有关的参考资料，如：本项目经核准的计划任务书或合同，上级机关的批文；属于本项目的其他已发表的文件；本文件中各处引用的文件、资料，包括所用到的软件开发标准。列出这些文件的标题、发表日期、出版单位等。2 概述2.1 模块的位置和作用说明本模块在整个系统中所处的位置，以文字或结构图的方式描述处于哪个层次，与哪些模块有接口。说明本模块的整个系统中的作用。2.2 设计功能目标说明本模块最终要实现的功能目标。2.3 设计方案描述简要介绍方案。若有专门的文

4、档，可以用。AC 需要描述如下情况是否满足 :1）支持IPV6 。整机的 ACCOMM 中，不涉及IPV6 ，暂时不考虑。2）支持互联互通3）热备4 ）跨越NAT5）大性能（含业务上的性能、各个通信模块之间的通信性能）6 ）支持DEBUG（ 在线的、细分到个体粒度的细节、自动化测试 ）7）编程上需要支持64bit ，跨平台代码，大小头8）支持可被监控和拉起9 ）支持不同种类的AP 的混接11 ）支持 license 的控制。12）支持各类标准化的网络模型。13 ）是否有利于OEM14 ）是否支持VR 的情况 .1.4 设计原则描述本模块所采用的设计原则。1.5 运行环境简要地说明对本模块的运行

5、环境的规定，包括软件和硬件环境。例如：运行该模块所需的硬件设备的最小配置及当前环境的运行配置。说明为运行该模块所需要的软件支持，如：操作系统、编译器、通信系统、数据库管理系统、文件管理系统、其他应用软件。3 流程图3.1 业务时序图说明设备（比如:AC）在整个网络中的业务流程，从而说明在此功能中，设备起什么功能。3.2 模块业务流程图该流程在设备（ AC ）内部各个模块的交互的流程。3.3 系统数据流图说明使用到的数据流图。特别是研究是否存在多任务（多线程）对数据访问的互斥性的问题。用流程图、文字说明模块的整体业务流程。4 模块结构设计4.1 模块总体结构设计用结构图、文字说明模块的划分和模块

6、间的层次关系，以及模块间的调用关系。4.1.1 子模块1（名称）结构设计（可选）用流程图、文字说明子模块1 的层次关系。4.1.2 子模块2 （名称） 结构设计（可选）用流程图、文字说明子模块2 的层次关系。5 模块功能设计5.1 模块功能描述详细描述模块完成的主要功能。5.2 子模块1 （名称）功能说明详细描述子模块1 所完成的功能。5.3 子模块2 （名称）功能说明详细描述子模块2 所完成的功能。6 模块性能设计详细描述模块具有的主要性能指标。说明模块占用内存的情况说明模块的设计容量， 及达到设计容量后对系统性能的影响 设计容量是指设计支持的最大xxx ，例如，支持的最大用户数、最大路由条

7、目数、最大过滤策略条数等等如果需要创建新的任务，请描述任务优先级、占用的资源、共享数据保护7 接口设计若涉及到通信机制，无论是系统间的还是进程（线程），需要采用标准的流程如：用户接口（根据实际情况，可用附录详细说明）；外部接口（说明本模块与外界的接口包括软件、硬件的接口，本模块与其他模块的接口）；内部接口（说明本模块内的各子模块间的接口）需要描述本模块提供的接口或调用的外部接口所使用的信号量，防止信号量死锁8 数据结构设计8.1 信号量及全局变量设计新增信号量的用途，互斥信号量的保护范围等如果引用了原有的信号量，也需说明所引用的用途、保护的范围等，特别注意是否会导致死锁说明新增的全局变量或所引

8、用的原有全局变量8.2 主要数据结构如果在概要设计阶段不能确定数据结构的框架，请在详细设计文档“数据说明”条款中进行描述。说明模块所使用的主要数据结构的名称、标识符、定义、作用等。可以列表说明主要数据结构的用途。例如Str1只用在子模块1, Str2只用在子模块n, Str3在子模块1和子模块n中都用，则如下表:数据结构子模块1子模块nStr1yesnoStr2noyesStr3yesyes若涉及到通信机制，无论是系统间的还是进程（线程），需要采用标准的消息。9兼容性设计说明版本向前、向后的兼容性，例如升级现网版本会不会出问题、版本配置方法是否兼容之前的 版本10热备设计说明版本与热备功能相关

9、的处理设计与描述说明。11调试支持信息说明需要包含统计类、 debug 类、 log 类的说明。说明正常运行所需要的调试支持信息，对其它模块的配合要求。12网管命令设计说明模块新增的网管命令，请按照以下模板添加新的命令。如果在此阶段还不能确定网管命令的名称和格式，需要在后续文档中评审。12.1 格式说明命令格式a)如果命令支持no,则在命令前加上nob) 命令行关键字用加粗字体c) 参数使用斜体字d) “ ”括起来的部分在命令配置时是可选的。e) x | y | . 表示从两个或多个选项中选取一个。f) x | y | . 表示从两个或多个选项中选取一个或者不选。g) <n,m>表

10、示从n到m的整数，包括 n和mi命令功能详细说明该命令的功能。参数解释说明参数的使用方法，取值范围，默认值，采用的数据类型等。如：参数描述取值范围PoolName地址池的名字字节长度为030all显示所有地址池all命令模式指明该命令的配置模式。如：用户模式、特权模式、全局模式、wireless模式、network模式、AP模式、SSID策略模式、advanced模式、时间策他配置模式、WAPI证书策略配置模式、MAC过滤策略配置模式、AP版本信 息配置模式、WMM配置模式、PSK配置模式、AP通用模板配置模式等使用指南应用场景应用场景前置条件使用限制命令配置特征不能重复配置，也不能修改，只能

11、用 no命令取消修改类型重复配置，指明重复配置的条目数和关键字板间分发指定板的命令，分发到所有板系统分发linuxvxlinux和vx都可用举例举例说明该命令该如何使用，如果命令本身有输出内容，请对输出内容的字段进行解释相关命令说明必须相关联需要同时配置的命令12.2 示例12.2.1 show ip-pool命令格式show ip-pool PoolNameshow all ip-pool命令功能显示地址池的相关配置信息和资源使用情况。参数解释参数描述取值范围PoolName地址池的名字字节长度为030all显示所有地址池all命令模式特权模式使用指南应用场景已经配置ip-pool命令配置特

12、征执行命令板间分发无系统分发无举例显示地址池的相关配置信息和资源使用情况。BNOS# show ip-pool stalBNOS# show Ip-pool stal's informationIp-pool name : stal (1#) * 地址池名称 *Network address : 1.1.1.0Subnet mask : 255.255.255.0Broadcast address: 1.1.1.255Allocate mode : dhcp - bgate alloc * 分配模式 *Allocate priority: HIGH * 分配的优先级 *Ip-pool

13、property : level 2Number of address occupied by device: 1.1.1.1Default router:(none)Actual router:(none)Service policy name:qian *服务策略*Filter policy name:(none)Auth-accounting rule:need auth, no acctPrimary DNS server:202.96.134.133Primary WINS server:(none)Secondary WINS server:(none)Router option:

14、1.1.1.1Lease option:100Number of address in ip-pool: 256 *地址池中存在的地址数目*Number of remained address for management: 3 * 保留地址 *Number of user free of authentication: 0Number of authenticated user: 0Number of unauthenticated user: 0Number of free address: 253 * 可供使用的 IP 地址*Number of address allocated by

15、dhcp(temporarily): 0Service policy after authentication: default表12-1 show ip-pool 显示信息解释表Ip-pool name地址池名称Network address网络地址Subnet mask子网掩码Broadcast address广播地址Allocate mode分配模式Allocate priority分配的优先级Ip-pool property地址池的优先级Number of address occupied by device已经分发的地址数目Default router默认路由Actual route

16、r实际路由Service policy name服务策略Filter policy name过滤策略Auth-accounting rule认证计费规则Primary DNS server主DNS服务器Primary WINS server主WINS服务器Secondary WINS server次WINS服务器Router option路由选项Lease option租期选项Number of address in ip-pool地址池中存在的地址数目Number of remained address for management保留地址Number of user free of aut

17、hentication免认证用户数目Number of authenticated user认证用户数目Number of unauthenticated user未认证用户数目Number of free address可供使用的IP地址Number of address allocated by dhcp(temporarily)Dhcp临时分配的地址数目Service policy after authentication认证后的服务策略12.2.2 interface命令格式no interfaceinterfacetype slotid/moduleid/ portidno inte

18、rfaceinterfacetypeslotid/moduleid/ portid.subif命令功能创建接口 /子接口，并进入接口 /子接口配置模式参数解释参数描述取值范围interfacetype接口接口类型FastEthernet|GigabitEthernet|XGigabitEthernet|Logic| NULLSlotid槽位号116Moduleid模块号，732 板卡的前面板的模 块号为1,前扣板 的模块号为21 | 2portid端口号类型物理/逻辑端口号范围015参数描述取值范围interfacetype接口接口类型FastEthernet|GigabitEthernet|

19、XGigabitEthernet|Logic| NULLSlotid槽位号116Moduleid模块号，732 板卡的前面板的模 块号为1,前扣板 的模块号为21 | 2NULL类型端口号范围 07subif子接口号0255命令模式全局配置模式使用指南应用场景对于 FastEthernet|GigabitEthernet|XGigabitEthernet类型的接口：创建接口:slotid/moduleid/portid创建子接口: slotid/moduleid/portid.subifSlotid -槽位号，当配置本板的接口时，槽位号可省略；当配置 的是其他板的接口时，必须填上该板的槽位号；

20、Moduleid732板卡的前面板的模块号为1,前扣板的模块号为2Portid - 端口号，前面板范围 0-4 ,前扣板的 GigabitEthernet 氾 围 0-7 ,前扣板的 XGigabitEthernet 范围 0-1Subif -子接口号，范围0-255对于Logic典型的接口：创建接口 ： slotid/ portid创建子接口 slotid/portid.subifSlotid -槽位号，不填槽位号，则对整机的每块板子都生效；填 上槽位号，则仅配置该指定的板子；Portid -范围 0-15Subif -子接口号，范围0-255对于NULL类型的接口：Slotid -槽位号，

21、不填槽位号，则配置本系统；填上槽位号，则 仅配置该指定的板子；Portid -范围 0-7命令配置特征可重复配置，关键字：端口!类型，端口id板间分发分发到所有板系统分发linux分发到vxworks执行，linux自己也执行举例(假设配置的都是0 口；子接口 100;有指定槽位号时，槽位号为 4)配置前面板，mouild =1CLI(config)# interface GigabitEthernet 1/0CLI(config)# interface GigabitEthernet 1/0.100CLI(config)# interface GigabitEthernet 4/1/0CLI(config)# interface GigabitEthernet 4/1/0.100配置前扣板XG 模块，其中 mouild=2CLI(config)# interfaceCLI(config)# interfaceCLI(config)# interfaceCLI(config)# interfaceXGigabitEthernet 2/0XGigabitEthern