软件项目详细设计文档模板.docx
《软件项目详细设计文档模板.docx》由会员分享，可在线阅读，更多相关《软件项目详细设计文档模板.docx（43页珍藏版）》请在冰点文库上搜索。
软件项目详细设计文档模板
研发生产中心
文档编号
版本
密级
商密
项目名称
系统
项目来源
（）
系统
详细设计说明书
（内部资料请勿外传）
编写：
日期：
检查：
日期：
审核：
日期：
批准：
日期：
公司
版权所有不得复制
文档变更记录
序号
变更（）说明
作者
版本号
日期
批准
.引言
编写目的和范围
术语表
参考资料
使用的文字处理和绘图工具
.全局数据结构说明
常量
变量
数据结构
.模块设计
用例图
功能设计说明
模块
模块
.接口设计
内部接口
外部接口
接口说明
调用方式
.数据库设计
.系统安全保密设计
说明
设计
数据传输部分
过滤分部
身份验证部分
.系统性能设计
.系统出错处理
1.引言
1.1编写目的和范围
说明写这份详细设计说明书的目的。
本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入输出、算法和流程逻辑等，为软件编程和系统维护提供基础。
本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。
1.2术语表
定义系统或产品中涉与的重要术语，为读者在阅读文档时提供必要的参考信息。
序号
术语或缩略语
说明性定义
项目经理
1.3参考资料
列出有关资料的名称、作者、文件编号或版本等。
参考资料包括：
．需求说明书、架构设计说明书等；
．本项目的其他已发表的文件；
．引用文件、资料、软件开发标准等。
资料名称
作者
文件编号、版本
资料存放地点
1.4使用的文字处理和绘图工具
文字处理软件：
绘图工具：
2.全局数据结构说明
本章说明本程序系统中使用的全局数据常量、变量和数据结构。
2.1常量
服务器地址
登录状态
2.2变量
用户账户结构体
2.3数据结构
包括数据结构名称，功能说明，具体数据结构说明（定义、注释、取值）等。
3.模块设计
3.1用例图
3.2功能设计说明
3.2.1登录模块
模块主要分为以下几个子模块：
子模块、子模块和子模块。
3.2.1.1设计图
3.2.1.2功能描述
此模块的主要功能是登录验证功能，保证程序的安全性问题。
用户需要验证用户和密码是否正确才能进行下一部操作。
3.2.1.3输入数据
变量名
类型
说明
用户名（必填）
密码（必填）
开场动画标志位
消息发送延迟时间
登录按钮是否能够点击标志位
3.2.1.4输出数据
字段
说明
结果，表示失败，表示成功，表示该养殖场地不存在，表示该已存在
用户名
密码
用户权限，代表系统用户，代表人事部，代表育苗场，代表生产部，代表加工厂，代表市场部，代表捕捞管理员
表现形式为：
3.2.1.5流程图
3.2.1.6源程序文件说明
3.2.1.7函数说明
对密码进行加密：
（密码）
将用户的账号密码暂时保存等下次登录时可以不用再次输入：
（名,用户名,密码）
3.2.1.8限制条件
必须在有网的条件下能使用登录功能。
3.2.2人员管理
3.2.2.1设计图
3.2.2.2功能描述
通过手持设备扫描员工的号，并在员工工号的输入框手动输入员工工号，并将两条数据上传到服务器中的数据库。
将员工工号与号相互绑定。
3.2.2.3输入数据
变量名
属性
说明
员工的员工号（必填）
员工的号（必填）如：
在检测数据的有效性是像是判断数据是否为空，当向服务器发送消息时服务器会对数据进行有效性检测，显示判断员工的员工号是否存在，员工的号是否已被其他工作人员应将绑定。
这些数据的获取离不开具有扫描功能的手持设备，对员工的卡进行扫描获取号。
才实现此功能
3.2.2.4输出数据
变量名
属性
说明
员工的员工号
员工的号
数据存储状态的标志位
3.2.2.5业务算法和流程
3.2.2.6数据设计
给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。
相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项与属性等。
）
3.2.2.7源程序文件说明
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
引入扫描的开发包
**
*.
*
{
;
保存员工信息
员工编号、卡号
员工信息
获取得到的卡号、编号
获取得到的
;
;
（）{
（）;
（）;
（）;
（）获取号和员工工号并保存到本地数据库
}
初始化控件
（）{
（）（）;
（）（）;
（）（）;
（）（）;
（）;
（）;
（）（）（）;
（""）;
代表从主界面跳转，代表从扫描接口跳转
（）{
（"请扫描员工卡号"）;
}（）{
（""）代表从员工录入跳转，代表从快递跳转
（）;
}
}
{
;
（）{
;
}
（）{
（（））{
:
（）;
（）;
（）{
（）;
}
{
（（）,）（）;
}
;
保存员工信息按钮到数据库,保存成功之后清空
要保证输入的信息不能全部为空
（（（））（（）））{
（）（）（）;
（）（）（）;
（）;
（）;
表示保存到本地数据库，表示本地数据库数据待删除
（）;
（）;
（）;
（）;
（""）;
（""）;
（（）,,）（）;
开辟一个新线程上传数据
（）（）;
（（）,,）（）;
}{
（（）,,）（）;
}
;
}
}
}
（）{
（）{
在这里进行.网络请求相关操作
（）;
（（））;
}
};
}
3.2.2.8函数说明
大扫描就成功时发出提示音（名称）;
程序的主体（）;
开启数据上传线程
3.2.2.9限制条件
要实现此功能必须要具备可以扫描功能的手持设备，不然无法扫描员工的号。
3.2.3池塘管理
3.2.3.1设计图
3.2.3.2功能描述
此模块主要实现的功能是扫描池塘的，并手动输入池塘编号，并将其保存到本地数据库。
并等到有网的条件下，将此条信息上传到服务器端的数据库。
实现池塘号与池塘编号的绑定。
3.2.3.3输入数据
变量名
属性
说明
池塘编号（必填）如:
育苗池
池塘的号（必填）：
在检测数据有效性时，需要检测数据是否为空。
这些数据的获取离不开具有扫描功能的手持设备，对池塘的卡进行扫描获取号。
才实现此功能
3.2.3.4输出数据
变量名
属性
说明
池塘编号
池塘的号
数据存储标志位
3.2.3.5业务算法和流程
3.2.3.6数据设计
给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。
相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项与属性等。
）
3.2.3.7源程序文件说明
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
**
*.
*
{
点击扫描池塘
绑定池塘编号和信息
池塘编号、卡号
池塘信息
获取得到的卡号、编号
获取得到的
;
;
（）{
（）;
（）;
（）;
（）;
}
初始化控件
（）{
（）（）;
（）（）;
（）（）;
（）（）;
（）;
（）;
（）;
}
{
;
（）{
;
}
（）{
（"","进入点击"）;
（（））{
:
（）;
（）;
（）{
（）;
}
{
（（）,）（）;
}
;
保存员工信息按钮到数据库,保存成功之后清空
要保证输入的信息不能全部为空
（（（））（（）））{
（）（）（）;
（）（）（）;
（）;
（）;
表示保存到本地数据库，表示本地数据库数据待删除
（）;
（）;
（）;
（）;
（""）;
（""）;
（（）,,）（）;
开辟一个新线程上传数据
（）（）;
}
{
（（）,,）（）;
}
;
}
}
}
（）{
（）{
在这里进行.网络请求相关操作
（）;
（）;
}
};
}
3.2.3.8函数说明
当扫描就成功时发出提示音（名称）;
程序的主体（）;
开启数据上传线程
3.2.3.9限制条件
要实现此功能必须要具备可以扫描功能的手持设备，不然无法扫描员工的号。
3.2.4育苗管理
3.2.4.1设计图
3.2.4.2功能描述
本功能主要是对员工对育苗池的操作进行记录，显示扫描员工、池塘。
还要扫描海产品的批次二维码，当员工对池塘进行操作时，需要记录操作类型，并且记录池塘的温度。
经这些信息记录到本地数据库。
3.2.4.3输入数据
变量名
属性
说明
员工的（必填）如：
池塘的号（必填）如：
批次二维码（必填）
操作类型（必填），包括：
喂食、换水、测温、入池、投放
温度（非必填）如：
℃
时间（必填）如：
在检测数据有效性时，需要检测与两个输入变量是否为空。
这些数据的获取离不开具有扫描功能与二维码扫描的手持设备，对池塘的卡进行扫描并获取号并且对池塘上的产品批次二维码进行扫描，获取产品批次二维码。
3.2.4.4输出数据
变量名
属性
说明
员工的
池塘的号
批次二维码，如：
操作类型
温度：
数据存储标志位
3.2.4.5业务算法和流程
3.2.4.6数据设计
给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。
相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项与属性等。
）
3.2.4.7源程序文件说明
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
**保苗阶段
*.
*
{
扫描员工
扫描池塘
保存信息
扫描池塘二维码批次信息
员工信息
池子信息
池塘二维码包含的批次信息
输入池塘温度
获取得到的
扫描类
获取得到的
获取得到的池子
扫描池子类
获取得到的
获取池子标签上的批次二维码信息
操作类型下拉控件
<>操作类型数据源
<>适配器适配操作类型列表
;
""池子温度，暂时用不到
;
;
;
（）{
（）{
（）{
（）（""）;
（""）;
（,）;
（）;
}
}
};
（）{
（）;
（）;
（）;
（）;
（）;
*
*开启二维码扫描线程
**
{
（）;
}（）{
（（）,"",）（）;
;
}
（）;
（）;
代码注册广播接收者
（）;
（""）;
（,）;
（（））;
}
{
（,）{
;
（"",）;
（"",）;
（）{
（）;
}
}
}
初始化控件
（）{
（）（）;
（）（）;
（）（）;
（）（）;
（）;
（）（）;
（）（）;
（）（）扫描池塘二维码批次信息
（）（）;
（）;
（）;
（）;
（）;
（）;
}
（）{
（）（）;
定义数据源
<>（）;
（"喂食"）;
（"换水"）;
（"测温"）;
（"入池"）;
（"投放"）;
<>（,）;
（）;
（）;
监听器获取选择内容
（（）{
（
>,,,）{
（）;
}
（
>）{
}
}）;
}
{
;
（）{
;
}
（）{
（（））{
:
（）;
（）;
（）{
（）;
}
{
（（）,,）（）;
}
;
:
（）;
（）;
（）{
（）;
}
{
（（）,,）（）;
}
;
:
（）;
;
保存员工信息按钮到数据库,保存成功之后清空
要保证输入的信息不能全部为空
（（（））（（））（）（（）（"投放"）））{
（）;
（）;
（）获取自定义时间格式
（）（）（）;
（）（）（）;
表示保存到本地数据库，表示本地数据库数据待删除
;
（（"喂食"））{
;
}（（"换水"））{
;
}（（"测温"））{
;
}（（"投放"））{
;
}（（"入池"））{
;
}
扫描二维码信息
（）（）（）;
（）;
（）;
（）;
（）;
（）;
（）{
（""）;
}{
（）;
}
（）;
（）;
（""）;
（""）;
（""）;
（""）;
开辟一个新线程上传数据
（）（）;
（（）,,）（）;
}{
（（）,,）（）;
}
;
}
}
}
（）{
（）{
在这里进行.网络请求相关操作
（）;
（）;
}
};
（）{
（）{
（）;
（）;
}
（）;
（）;
}
}
3.2.4.8函数说明
当扫描就成功时发出提示音（名称）;
程序的主体（）;
开启数据上传线程
3.2.4.9限制条件
限制条件是，必须使用具有和二维码扫描功能的手持设备才能完成此功能。
3.2.5加工包装
3.2.5.1设计图
3.2.5.2功能描述
此模块的主要功能是扫描员工的号，并显示到屏幕上去。
工作人员选择产品类型，扫描产品二维码，一次可以扫描多个产品，并将数据保存到本地数据库。
3.2.5.3输入数据
变量名
属性
说明
员工的（必填）如：
产品二维码（必填）
产品类型（必填），包括：
冻海参、淡海参、盐海参、鲜活海参、盐渍海参、与时海参
操作时间。
如
在检测数据有效性时，需要检测与两个输入变量是否为空。
这些数据的获取离不开具有扫描功能与二维码扫描的手持设备，对池塘的卡进行扫描并获取号并且对池塘上的产品批次二维码进行扫描，获取产品批次二维码。
3.2.5.4输出数据
变量名
属性
说明
员工的如：
产品二维码.
产品类型，包括：
冻海参、淡海参、盐海参、鲜活海参、盐渍海参、与时海参
操作时间。
如
数据存储状态标志位。
如：
3.2.5.5业务算法和流程
3.2.5.6数据设计
给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。
相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项与属性等。
）
3.2.5.7源程序文件说明
给出本程序的各源程序文件的说明，包括源程序文件名称与其所在目录，功能说明，包含的前导文件与函数名称等。
3.2.5.8函数说明
当扫描就成功时发出提示音（名称）;
程序的主体（）;
开启数据上传线程
为下拉菜单添加选项：
（）
将扫描多个二维码：
（类型的数组类型的二维码值），返回值为含有不同产品二维码值的<>类型的数组。
3.2.5.9限制条件
限制条件是，用户具有是由此功能的权限和使用具有和二维码扫描功能的手持设备才能完成此功能。
3.2.6物流管理
3.2.6.1设计图
3.2.6.2功能描述
本功能的主要功能是将一批货物的二维码与快递公司、快递单号绑定到一块，并记录当前操作的员工。
用户扫描产品二维码就可以知道产品的运输途径。
简要描述子模块的业务功能。
3.2.6.3输入数据
变量名
属性
说明
员工的（必填）如：
产品二维码（必填）
物流快单号
物流公司（必填），包括：
顺丰、
操作时间。
如
3.2.6.4输出数据
变量名
属性
说明
员工的。
如：
产品二维。
如：
物流快单号,如:
物流公司，包括：
顺丰、、申通快递、圆通快递、中通快递、韵达快递、百世汇通等。
操作时间。
如：
数据存储标志位，如：
3.2.6.5业务算法和流程
3.2.6.6数据设计
给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。
相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项与属性等。
）
3.2.6.7源程序文件说明
给出本程序的各源程序文件的说明，包括源程序文件名称与其所在目录，功能说明，包含的前导文件与函数名称等。
3.2.6.8函数说明
当扫描就成功时发出提示音（名称）;
程序的主体（）;
开启数据上传线程
为下拉菜单添加选项：
（）
3.2.7数据管理
模块主要分为以下几个子模块：
子模块、子模块和子模块。
3.2.7.1设计图
数据分类选择界面
本地数据显示界面
3.2.7.2功能描述
将本地的数据库保存的信息以可视化的界面显示出来，便于用户查询。
3.2.7.3输入数据
详细描述用户输入的数据（包括任何输入设备）以与这些数据的有效性检验规则。
详细描述从物理模型中的哪些表获取数据以与获取这些数据的条件。
3.2.7.4输出数据
详细描述子功能所产生的数据以与这些数据的表现形式。
3.2.7.4.1业务算法和流程
从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。
3.2.7.5数据设计
给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。
相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项与属性等。
）
3.2.7.6源程序文件说明
给出本程序的各源程序文件的说明，包括源程序文件名称与其所在目录，功能说明，包含的前导文件与函数名称等。
3.2.7.6.1函数说明
删除数据（）
重写方法（）{
3.2.8设置
3.2.8.1设计图
网络服务器设置页面
3.2.8.2功能描述
显示当前网络服务器地址，并可以变更服务器地址。
3.2.8.3输入数据
变量名
属性
说明
服务器网络地址（必填）如：
3.2.8.4输出数据
变量名
属性
说明
服务器网络地址如：
3.2.8.5业务算法和流程
设置流程图
3.2.8.6函数说明
创建指定文件名的文件：
（"文件名"）;
读取指定文件名的文件：
（"文件名"）;返回网络地址。
4.接口设计
4.1内部接口
4.2外部接口
4.2.1接口说明
例如：
子系统通过从子系统取得等，相关标准，调用示例，可根据需要增加章节描述接口。
4.2.2调用方式
例如：
内部接口调用：
例:
**
*通过用户服务号码取得该客户认证密码等信息，如果该客户存在返回为，其他情况参考错误编码
*
（）;
5.数据库设计
详见[数据库设计说明书]
如果数据库设计内容比较少，则直接在此处描述。
6.系统安全保密设计
6.1说明
例如：
由于存在与外部系统的接口,所以需要考虑访问安全的问题.
6.2设计
例如：
分为数据传输部分过滤部分,身份验证部分.[章节可补充]
6.2.1数据传输部分
例如：
在部分数据传递的时候,考虑以协议,需要在部署的时候作相关处理.
6.2.2过滤分部
例如：
可在系统前端通过实现,该实现对该地址访问的过滤作用.可信任地址通
升级会员 