拳头详细设计说明书.doc

详细设计说明书

拳 头 详 细 设 计 说 明 书

文档编号：10086
文档信息： 拳头详细设计报告
文档名称： 拳头详细设计说明书
文档类别： M001
密 级： 密0010
版本信息： Q01023
建立日期： 2016-5-25

创 建 人：
审 核 者：
批 准 人：
批准日期： 2016-5-28

保 管 人：
存放位置：
编辑软件：

目 录
第一章 导言 2
1.1 目的 2
1.2 范围 2
1.3 术语定义 2
1.4 相关文档 2
1.5 参考资料 3
第二章 功能模块实现设计 4
2.1 公用模块实现设计 4
2.2 专用模块实现设计 5
2.3 存储过程实现设计 6
2.4 触发器实现设计 6
第三章 外部接口实现设计 8
3.1 外部接口1实现设计 8
3.2 外部接口2实现设计 8
第四章 其它实现设计 10
4.1 部门角色授权设计 10
4.2 其它详细设计 10
第五章 程序文件清单 10

文档类别使用对象
文档类别
本文档是软件系统详细设计说明书的模板，是详细设计说明书的书写标准及规范，是技术文档。
使用对象
该文档使用人员包括：
l 系统分析人员
l 系统设计人员
l 系统编码人员
l 系统测试人员
l 系统维护人员
第一章 导言
1.1 目的
本文档的目的旨在推动拳头公司的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。
详细设计的详细程度，应达到可以编写程序的水平。
1.2 范围
根据OSI七层传输方式来进行，分为七层，每层独立完成各层的任务，并每层向下兼容，如果下层要向上层进行传输，需使用加密算法来进行。
1.3 术语定义
序号
术语名称
术语定义
1
详细设计
在概要设计的基础上，对其功能模块或部件进行实现设计，使编程人员据此能顺利书写出程序代码。
2
存储过程
存放在数据库服务器上的一段程序，它能被其它程序调用，以完成对数据库表的某些规定操作。
3
触发器
存放在数据库服务器上的一段程序，当触发条件满足时它就被执行，以完成对数据库表的某些规定操作。
4
算法
详细设计中实现某项功能的数据处理方法及处理流程。

1.4 相关文档
1. 用户使用手册
1.5 参考资料
1. 软件需求规格说明书
2. 概要设计说明书
第二章 功能模块实现设计
2.1 公用模块实现设计
2.1.1登录系统
1. 模块编号：G-001
2. 模块名称：系统登录
3. 模块功能：
1) 对用户身份进行验证。
2) 根据用户权限进行页面控制访问。
4. 模块背景描述：
1) 用户使用系统时需要在页面之间导航
2) 系统需要实现对用户的重要工作的提示功能
3) 为了保证系统用户的安全性，提供密码修改功能
4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统
5) 完成相应的任务，退出系统，保证用户帐号的安全性。
5. 调用参数的描述：
1) 输入用户名
2) 输入密码
操作对象的描述：
1) 本功能要读取用户信息，用户对应角色权限信息管理。
2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。
3) 系统日志将在G-003 —G-005系统日志模块中作用。
操作流程的描述：
输入正确的用户名和密码，点击登录。

6. 模块调用方法：打开软件
7. 模块测试日期：2016/5/27
8. 相关表结构设计：
2.1.2系统快捷操作
1. 模块编号：G-002
2. 模块名称：快捷操作
3. 模块功能：
1) 使用键盘上的键对系统进行快捷操作
2) 根据用户权限进行页面控制访问。
4. 模块背景描述：
1) 方便管理员和用户进行一系列的操作
操作流程的描述：
使用键盘上的键进行操作一达到快捷方便的目的

5. 模块调用方法：键盘键入、鼠标点击等
2.1.3系统管理

6. 模块编号：001
7. 模块名称：系统登录
8. 模块功能：
1) 对用户身份进行验证。
2) 根据用户权限进行页面控制访问。
9. 模块背景描述：
1) 用户使用系统时需要在页面之间导航
2) 系统需要实现对用户的重要工作的提示功能
3) 为了保证系统用户的安全性，提供密码修改功能
4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统
5) 完成相应的任务，退出系统，保证用户帐号的安全性。
10. 模块算法设计：
入口说明：用户通过用户界面点击相应的链接。
输入参数：session对象中记录的用户ID
出口说明：系统完成相应的操作
11. 调用参数的描述：
1) 输入用户名
2) 输入密码
操作对象的描述：
1) 本功能要读取用户信息，用户对应角色权限信息管理。
2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。
3) 系统日志将在003 —005系统日志模块中作用。
注意事项：
模块编写日期：2016/5/29
模块编写日期：2016/5/28
模块修订日期：写2016/5/28
模块测试日期：2016/5/29
12. 相关表结构设计：
2.1.4用户管理
1. 模块编号：001
2. 模块名称：系统登录
3. 模块功能：
1) 对用户身份进行验证。
2) 根据用户权限进行页面控制访问。
4. 模块背景描述：
1) 用户使用系统时需要在页面之间导航
2) 系统需要实现对用户的重要工作的提示功能
3) 为了保证系统用户的安全性，提供密码修改功能
4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统
5) 完成相应的任务，退出系统，保证用户帐号的安全性。
5. 模块算法设计：
入口说明：用户通过用户界面点击相应的链接。
输入参数：session对象中记录的用户ID
出口说明：系统完成相应的操作
6. 调用参数的描述：
1) 输入用户名
2) 输入密码
操作对象的描述：
1) 本功能要读取用户信息，用户对应角色权限信息管理。
2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。
3) 系统日志将在003 —005系统日志模块中作用。
2.1.3部门管理
1. 模块编号：001
2. 模块名称：系统登录
3. 模块功能：
1) 对用户身份进行验证。
2) 根据用户权限进行页面控制访问。
4. 模块背景描述：
1) 用户使用系统时需要在页面之间导航
2) 系统需要实现对用户的重要工作的提示功能
3) 为了保证系统用户的安全性，提供密码修改功能
4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统
5) 完成相应的任务，退出系统，保证用户帐号的安全性。
5. 模块算法设计：
入口说明：用户通过用户界面点击相应的链接。
输入参数：session对象中记录的用户ID
出口说明：系统完成相应的操作
6. 调用参数的描述：
1) 输入用户名
2) 输入密码
操作对象的描述：
1) 本功能要读取用户信息，用户对应角色权限信息管理。
2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。
3) 系统日志将在003 —005系统日志模块中作用。
7. 模块调用方法：详细列出不同的调用的方式、入口参数、出口参数、异常处理。
2.1.3职位管理
8. 模块编号：001
9. 模块名称：系统登录
10. 模块功能：
1) 对用户身份进行验证。
2) 根据用户权限进行页面控制访问。
11. 模块背景描述：
1) 用户使用系统时需要在页面之间导航
2) 系统需要实现对用户的重要工作的提示功能
3) 为了保证系统用户的安全性，提供密码修改功能
4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统
5) 完成相应的任务，退出系统，保证用户帐号的安全性。
12. 模块算法设计：
入口说明：用户通过用户界面点击相应的链接。
输入参数：session对象中记录的用户ID
出口说明：系统完成相应的操作
13. 调用参数的描述：
1) 输入用户名
2) 输入密码
操作对象的描述：
1) 本功能要读取用户信息，用户对应角色权限信息管理。
2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。
3) 系统日志将在003 —005系统日志模块中作用。
特别引用的描述：
要使用到001系统登录模块的功能

2.1.3角色管理

1. 模块编号：001
2. 模块名称：系统登录
3. 模块功能：
1) 对用户身份进行验证。
2）根据用户权限进行页面控制访问。
4. 模块背景描述：
1) 用户使用系统时需要在页面之间导航
2) 系统需要实现对用户的重要工作的提示功能
3) 为了保证系统用户的安全性，提供密码修改功能
4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统
5) 完成相应的任务，退出系统，保证用户帐号的安全性。
5. 模块算法设计：
入口说明：用户通过用户界面点击相应的链接。
输入参数：session对象中记录的用户ID
出口说明：系统完成相应的操作
6. 调用参数的描述：
1) 输入用户名
2) 输入密码
操作对象的描述：
1) 本功能要读取用户信息，用户对应角色权限信息管理。
2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。
3) 系统日志将在003 —005系统日志模块中作用。
2.1.3日志管理
1. 模块编号：001
2. 模块名称：系统登录
3. 模块功能：
1) 对用户身份进行验证。
2) 根据用户权限进行页面控制访问。
4. 模块背景描述：
1) 用户使用系统时需要在页面之间导航
2) 系统需要实现对用户的重要工作的提示功能
3) 为了保证系统用户的安全性，提供密码修改功能
4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统
5) 完成相应的任务，退出系统，保证用户帐号的安全性。
5. 模块算法设计：
入口说明：用户通过用户界面点击相应的链接。
输入参数：session对象中记录的用户ID
出口说明：系统完成相应的操作
6. 调用参数的描述：
1) 输入用户名
2) 输入密码
操作对象的描述：
1) 本功能要读取用户信息，用户对应角色权限信息管理。
2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。
3) 系统日志将在003 —005系统日志模块中作用。
特别引用的描述：
7. 模块测试日期：2016/5/29
、、 、、
第三章 其它实现设计
3.1 部门角色授权设计
部门
模块

用户管理
userserver

●

系统服务器
server

●
●

●

●
维护模块
W

●

BUG修复
Bw

●

●
后台模块
Bs
●

●

●

3.2 其它详细设计
存储过程：
根据具体得业务逻辑确定输入参数个数，类型,确定对哪几个表进行何种作。
在定义存储过程时，要使用其完成单一、相对集中的任务，不要定义已由其他提供功能的过程。
函数 ：
函数与存储过程非常相似，它也是存储在数据库中的对象。但是可以在SQL命令中使用函数。就好像建立自己的substr函数一样
触发器 ：
触发器是存储在数据库中的程序，它在某一特定事件发生时执行。这些程序可以用PL/SQL和java语言编写，也可以用作c语言的调用，数据库允许用户定义这些程序，然后在相关的表，视图或者数据库动作执行insert，update或delete语句时执行。
第四章 程序文件清单

子系统名：拳头
程序文件名： QT.exe
运行平台：windows系列 ，Mac IOS系统
简要描述：拳头系统概要设计文档的组成部分，编写数据库设计文档的目的是：明确数据库的表名、字段名等数据信息，用来指导后期的数据库脚本的开发，本文档遵循《拳头数据库设计和开发规范》。本文档的读者对象是需求人员、系统设计人员、开发人员、测试人员。