详细设计说明书模版.docx
《详细设计说明书模版.docx》由会员分享，可在线阅读，更多相关《详细设计说明书模版.docx（12页珍藏版）》请在冰点文库上搜索。
详细设计说明书模版
文档编号
文档版本
密级
摘要说明
MPXH-OS-XX-**
机密
产品名称
产品版本
共X页
（网闸探测器）详细设计说明书
编写者：
____________________日期：
____/____/____
评审者：
____________________日期：
____/____/____
批准者：
____________________日期：
____/____/____
北京迈普翔华软件技术有限公司
版本及修改控制
版本/状态
修订页码范围
修订内容
修订人
修订时间
1引言
1.1编写目的
本说明书在概要设计的基础上，对网闸探测器的各模块、程序、子系统分别进行了实现层面上的要求和说明。
本说明书的预期读者为客户、业务或测试人员、用户文档编写者、网管、项目管理人员。
1.2背景
说明：
A.软件系统的名称：
网闸探测器
B.任务提出者：
郑州信大捷安公司
开发者：
郑州信大捷安软件开发团队
C.本系统将是独立的系统
1.3术语、定义和缩写词
列出本文件中用到的专门术语、定义和外文首字母组词的原词组。
1.4参考资料
列出与软件开发有关的参考资料，如：
1.本项目的经核准的计划任务书或合同、上级机关的批文；
2.属于本项目的其他已发表的文件；
3.本文件中各处引用的文件、资料，包括所需用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2程序系统的结构
3NMAP扫描模块设计说明
从本章开始，逐个地给出各个层次中的每个程序的设计考虑。
对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。
3.1程序描述
A.目的和意义
NMAP是一款免费的开源工具，它用来扫描计算机的各项基本信息，如端口、操作系统类型、MAC地址等等。
NMAP扫描出来的各项信息对于探测网闸有着重要的参考作用，考虑到本项目时间的紧迫性和NMAP的强大性、开源性等因素，本项目采用NMAP来对目标机器进行扫描。
B.特点说明
NMAP的扫描方式非常灵活，有TCP连接探测、TCP同步探测、UDP探测、RPC探测等等，可以单独使用一种扫描方式或者多种扫描方式相结合。
NMAP运行通常会得到被扫描主机端口的列表，包括端口的服务名（如果可能）、端口号、状态和协议等信息。
根据使用的功能选项，nmap也可以报告远程主机的下列特征：
使用的操作系统、TCP序列、运行绑定到每个端口上的应用程序的用户名、DNS名、主机地址是否是欺骗地址、以及其它一些东西。
3.2功能
IPO图表
模块名称：
NMAP扫描模块
使用者：
调用模块
输入部分I
处理描述P
输出部分O
1．添加扫描任务，输入IP和端口范围；
2．设置各项参数：
扫描类型和延迟时间；
3．提交扫描请求。
1．输入IP是否合法的实时检查，端口范围如不设置则默认扫描常见端口；
2．根据所设置的各项参数，在允许的延迟时间里，对单个IP或者多个IP进行扫描。
1．把扫描结果重定向到一个可读的文件中，里面至少包含扫描主机IP、活动端口列表、MAC地址和操作系统类型。
说明该程序应具有的功能，可采用IPO图（即输入-处理-输出图）的形式。
3.3性能
精度：
根据设置参数得到不同的扫描的扫描精度；
灵活性：
可对扫描方式进行灵活的搭配；
时间特性：
可分别设置每台主机的扫描时间、等待时间和两次探测的间隔时间
说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。
3.4输入项
名称
标识
数据类型
有效范围
IP地址
IP
Int
1-255
端口范围
PORT
Int
0-65535
操作系统类型
OS
String
MAC地址
MAC
String
给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
3.5输出项
输入项
输出项
IP地址
IP地址
端口范围
目标机器的所有开放端口
操作系统类型
操作系统类型
MAC地址
MAC地址
给出对每一个输出项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输出的形式、数量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等等。
3.6算法
本部分没有采用自定义的算法。
详细说明本程序所选用的算法，具体的计算公式和计算步骤。
3.7程序逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。
3.8接口
用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。
3.9存储分配
本程序直接运行NMAP软件，直接的内存分配由NMAP运行时分配；
本组件内所依赖的变量、结构要求全部由NMAP软件申明。
根据需要，说明本程序的存储分配。
3.10注释设计
说明准备在本程序中安排的注释，如：
A.加在模块首部的注释；
B.加在各分枝点处的注释；
C.对各变量的功能、范围、缺省条件等所加的注释；
D.对使用的逻辑所加的注释等等。
3.11限制条件
1.无法扫描本机。
可以选择将该工具装在别的机器上，然后对本机进行扫描。
或者可以通过设定一些参数来实现高级别的扫描。
2.Nmap支持以太网络连接和一些802.11无线网络连接，而对于一些PPP拨号网络则不支持，因为微软在WindowsXPSP2中移除了对rawTCP/IPsocket的支持。
说明本程序运行中所受到的限制条件。
3.12测试要点
说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序等的规定。
3.13尚未解决的问题
无。
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
4调用模块设计说明
从本章开始，逐个地给出各个层次中的每个程序的设计考虑。
对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。
4.1程序描述
A.目的和意义
本程序直接调用强大的NMAP扫描工具对局域网机器进行扫描以缩短软件开发周期。
B.特点说明
NMAP的功能选项可以组合使用，本程序能从用户界面获取各个功能选项，并把它们组合在一起作为一个参数传递给NMAP进行扫描。
4.2功能
IPO图表
模块名称：
调用模块
使用者：
用户
输入部分I
处理描述P
输出部分O
1．从用户界面获取各项设置参数；
2．把参数传递给NMAP。
1．调用NMAP扫描模块；
2．根据用户指令进行相应扫描。
1．把扫描结果重定向到一个可读的文件中，里面至少包含扫描主机IP、活动端口列表、MAC地址和操作系统类型。
说明该程序应具有的功能，可采用IPO图（即输入-处理-输出图）的形式。
4.3性能
精度：
严格区分哪些功能选项不能组合在一起扫描；
灵活性：
必须把扫描结果重定向到一个可读的文件中；
时间特性：
可设置定时扫描。
说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。
4.4输入项
名称
标识
数据类型
有效范围
IP地址
IP
Int
1-255
端口范围
PORT
Int
0-65535
操作系统类型
OS
String
MAC地址
MAC
String
给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
4.5输出项
输入项
输出项
IP地址
IP地址
端口范围
目标机器的所有开放端口
操作系统类型
操作系统类型
MAC地址
MAC地址
给出对每一个输出项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输出的形式、数量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等等。
4.6算法
本部分没有采用自定义的算法。
详细说明本程序所选用的算法，具体的计算公式和计算步骤。
4.7程序逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。
4.8接口
用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。
4.9存储分配
无特别要求。
根据需要，说明本程序的存储分配。
4.10注释设计
说明准备在本程序中安排的注释，如：
E.加在模块首部的注释；
F.加在各分枝点处的注释；
G.对各变量的功能、范围、缺省条件等所加的注释；
H.对使用的逻辑所加的注释等等。
4.11限制条件
无。
说明本程序运行中所受到的限制条件。
4.12测试要点
说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序等的规定。
4.13尚未解决的问题
无。
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
5程序2设计说明
用类似于上一章的方式，说明第2个程序乃至第N个程序的设计考虑。
……
升级会员 