软件工程详细设计阶段详细设计说明书样本.doc

网上报名管理系统详细设计说明书V1.0(版本号)拟 制 人_审 核 人_批 准 人_二00八年十一月十日详细设计说明书1.引言1.1编写目的 在前一阶段( 概要设计说明书) 中, 已解决了实现该系统需求的程序模块设计问题。包括如何把该系统划分成若干个模块、 决定各个模块之间的接口、 模块之间传递的信息, 以及数据结构、 模块结构的设计等。在以下的详细设计报告中将对在本阶段中对系统所做的所有详细设计进行说明。在本阶段中, 确定应该如何具体地实现所要求的系统, 从而在编码阶段能够把这个描述直接翻译成用具体的 程序语言书写的程序。主要的工作有: 根据在需求分析说明书中所描述的数据、 功能、 运行、 性能需求, 并依照概要设计说明书所确定的处理流程、 总体结构和模块外部设计, 设计软件系统的结构设计、 逐个模块的程序描述( 包括各模块的功能、 性能、 输入、 输出、 算法、 程序逻辑、 接口等等) , 解决如何1、 输入考生的注册信息、 报名信息等; 2、 判断信息的正误并采取相应的处理步骤; 3、 进行数据库的查询、 修改工作; 4、 接受并判断错误, 输出相应的出错消息; 在以下的各个阶段中, 用户操作手册将与本阶段的工作紧密结合, 努力作到让用户易懂易学。测试报告和维护报告也将参考本说明书, 检验本系统的各项性能指标, 及时发现纰漏及时修补, 一定要把功能强大、 稳定可靠、 便于维护的网上报名管理系统交到用户手中。1.2背景a. 待开发系统的名称: 网上报名管理系统b. 本项目的任务提出者: 开发者: 用户: 1.3定义SQL SERVER: 系统服务器所使用的数据库管理系统( DBMS) 。SQL: 一种用于访问查询数据库的语言事务流: 数据进入模块后可能有多种路径进行处理。主键: 数据库表中的关键域。值互不相同。外部主键: 数据库表中与其它表主键关联的域。ROLLBACK: 数据库的错误恢复机制。1.4参考资料需求规格说明书 网上报名管理系统软件开发小组概要设计说明书 网上报名管理系统软件开发小组软件工程基础 周苏、 王文等 浙江科技技术出版社 2. 系统的结构以下给出网上报名管理系统的功能模块图和用例图以说明各个模块之间的层次关系, 且在模块设计中会给出各个模块的详细设计方案。网上报名管理系统功能模块图 图1我们开发的网上报名系统主要分为三大模块: 考生网上报名, 管理员考务管理, 管理员系统管理。对于录报名网站的考生, 经过网上报名系统的考生界面能够进行注册; 能够进行网上报名( 填报信息、 上传照片等); 能够在指定时间范围内申请报名, 录入、 修改报名信息或取消报名。对于登录报名网站的系统管理员, 经过网上报名系统的管理员界面能够维护考生信息( 考生报名数据, 交费信息等) ; 能够查询考生信息( 报名状态, 交费状态等) ; 能够统计考生信息( 报名人数, 交费情况等) , 管理员还能够对网上报名信息系统进行管理包括用户注册信息的管理; 对系统用户、 角色及其相应权限的设置等。网上报名系统的功能模块图如图1 所示网上报名管理系统用例图 图2用例分析是基于 UML 的面向对象建模过程的一个显著的特点, 在基于 U M L 的建模过程中, 用例处在一个核心的位置。用例除了被用来准确获取用户需求以外, 它还将驱动系统整个开发过程: 包括系统分析、 系统设计, 以及系统实现、 测试、 配置等。在 UML 中一个用例模型由若干个用例图描述, 用例图的主要元素是用例和参与者。因为用例是从参与者角度来看系统, 因此要获取系统的用例, 首先要确定系统边界, 识别出系统的参与者, 然后再对每个参与者列出它的用例, 并由此来确定系统最终的用例。对于网上报名系统进行用例建模, 首先确定用例图的系统边界为”网上报名系统”, 然后根据系统边界来识别与系统发生交互的”角色”。根据对系统的业务流程分析, 确定与”网上报名系统”有信息交互的用例角色为报名者、 报名管理员和时间。经过对系统功能需求的分析, 建立系统用例图如图2 所示。3注册模块(registerFrom)设计说明 3.1模块描述该模块主要实现考生注册的功能, 考生输入相关注册信息, 进行注册, 只有在注册后, 考生才能够登陆, 并进行报名, 修改和查询信息操作。3.2功能1、 对考生填入的注册信息进行检测: 注册名能够为汉字但不能重复, 身份证号要满足一定的格式(16位或18位)且同一身份证号只能注册一次, 考生姓名不能为空, 密码重复两次输入相同检测。若在以上检测中不经过, 则给出对应的消息提示。2、 将经过验证的注册信息填入数据库中注册信息表中。3、 对于如果某人的身份证号已经被别人恶意注册的情况, 给出管理员联系方式或提供相应的解决方案。3.3输入项 注册名string 姓名string 身份证号码string登陆密码string重复密码string3.4设计方法( 算法) 在考生注册时, 填完一项信息后( 除密码外) , 就对其填入的信息进行检查。1、 注册名和身份证号唯一, 在填入信息后, 将填入的信息同数据库中注册信息表中相应字段进行比较, 若相同则给出提示消息。2、 身份证格式验证, 用字符串的正则表示式对身份证格式匹配。3、 密码输入检查, 将输入的两个密码做stringcompare。4登陆模块( loginFrom) 设计说明4.1模块描述该模块主要实现考生和管理员的登陆功能, 在登陆时需要区分登陆者的身份, 根据登陆者身份不同登陆到不同界面。 4.2功能1、 考生根据其注册名和密码登陆, 在登陆时检查其注册名和密码的正确性。登陆成功后进入考生浏览界面。2、 管理员经过其用户名和其密码登陆, 在登陆时检查其注册名和密码的正确性。登陆成功后进入管理员管理界面。且根据不同的权限看到的界面也是不同的。4.3输入项登陆类型string 登陆名string 登陆密码string4.4设计方法( 算法) 1、 在选择登陆类型后, 根据所选择的类型若考生则在注册表中查询信息与其填入的登陆名和登陆密码匹配, 若管理员则在用户表中查询信息与其填入的登陆名和登陆密码匹配。2、 在登陆窗口中不能直接经过关闭窗口的形式直接进入主窗体, 能够经过设计标记位exitflag, 只有在密码输入正确的情况才能够进入系统。3、 另外, 设计计数标记count, 每次登陆count加1, 三次登陆失败, 程序会自动退出。5考生报名模块( signUpFrom) 设计说明5.1模块描述该模块用于考生填写报名资料, 进行报名。 5.2功能1、 对于以前已经参加过报名的考生-老考生, 在登陆成功后, 直接显示其以前的信息( 包含照片信息) , 信息能够修改。( 因此有一张对应的历史表, 包含照片的表, 历史信息的导入功能不用实现) 。系统中有一相标记, 标记这个人是否是以前的考生, 对于老考生, 不用审核。2、 姓名和身份证号只能显示, 不能修改。3、 点击提交按钮后, 考生的报名信息存到数据库中的考生资料表中。4、 性别、 所学专业、 最高学历、 专业技术资格、 单位性质 只允许选择, 不能修改和录入。相应的有性别、 所学专业、 最高学历、 专业技术资格、 单位性质 维护的界面。5、 图片一定要为JPG格式, 大小不能超过50K。6、 毕业时间、 资格取得时间精确到月, 从业证档案号、 会计工作年限、 邮政编码、 联系电话中只允许录入数字。5.3输入项输入项如下界面所示( 其中姓名和身份证号只能显示, 不能修改) 5.4设计方法( 算法) 1、 考生报名时不需自己填入考生姓名和身份证号, 在登陆时, 设置全局变量, 记录下登陆考生的姓名和身份证号。此时系统自动显示考生姓名和身份证号。2、 性别、 所学专业、 最高学历、 专业技术资格、 单位性质 只允许选择, 使用datareader将数据库中有的信息显示。3、 照片在上传时需要.JPG后缀。大小也需要判断。4、 对于老考生, 在数据库中查询, 并直接在界面显示查询信息。6书籍购买模块( bookBuyyingFrom) 设计说明6.1模块描述在考生报名成功后, 能够点击进入书籍购买界面, 选择其要购买的图书。 6.2功能1、 显示能够购买的书籍名称, 作者, 出版社, 价格等信息。2、 考生可选择其预购买的书籍。6.3输出项书籍名string 作者string 出版社string价格double6.4输入项 书籍名称 string6.5设计方法( 算法) 1、 用相应的控件列出所有可供购买的图书信息, dataadapter和dataset。2、 选中要购买的书籍, 提交后, 将信息存入数据库的书籍购买表中。7考生信息维护模块( uModfyFrom) 设计说明7.1模块描述该模块主要实现管理员对考生信息的管理, 可对考生信息进行增删改功能, 其可分为两个子模块, 在考生资料经过审核后修改审核标记位, 在考生交费后修改交费标记位。 7.2功能1、 在考生资料经过审核后修改审核标记位。2、 在考生交费后修改交费标记位。7.3输入项审核标记bool 交费标记bool 7.4设计方法( 算法) 输入待审核考生身份证号, 显示对应考生资料, 并对其进行审核, 若经过则在审核经过选项打钩, 将其审核标记置true。在考生交费后, 则在交费选项打钩, 将其审核标记置true。只有在审核经过后, 才能交费。8考生信息查询模块( uSelectFrom) 设计说明8.1模块描述该模块主要实现管理员对考生信息的查询, 能够根据不同的类别查询该类别的考生信息。 8.2功能经过主键( 身份证号或报名序号) 查询某个考生的交费信息, 审核信息, 个人资料等。8.3输入项主键string8.4输出项 各种信息8.5设计方法( 算法) 用SQL语句进行数据库查询, 找出需要的资料并显示。支持模糊查询和多条件查询where 1=1 语句的使用。9考生信息统计模块( uCountFrom) 设计说明9.1模块描述该模块主要实现管理员对考生信息的统计, 能够统计报名人数, 经过审核人数, 已交费人数等信息。 9.2功能1、 统计报名人数。2、 统计经过审核人数。3、 统计已交费人数4、 统计购买书籍数目9.3输出项已审核人数int 已交费人数int 报名人数int 9.4设计方法( 算法) 经过设计相关按钮, 直接执行SQL查询语句, 得出相应数据。10注册信息管理模块( uRegistMngFrom) 设计说明10.1模块描述如果某人的身份证号已经被别人恶意注册过, 管理员能够进行删除。 10.2功能1、 能够查询考生注册信息。2、 对考生注册信息表进行增删改。 10.3设计方法( 算法) 使用相应的SQL语句对注册信息表进行增删改查操作。11角色权限管理模块( UserMngFrom) 设计说明11.1模块描述该模块主要实现对不同级别的管理员的权限的管理。一个管理员能够对应多个角色, 同时一个角色能够对应多种权限。 11.2功能1、 修改角色表, 增加, 删除, 修改角色。2、 修改权限表, 增加, 删除, 修改权限。3、 修改用户角色表, 增加, 删除, 修改用户所对应的角色。4、 修改角色权限表, 增加, 删除, 修改角色所对应的权限。 11.3设计方法( 算法) 经过对角色表, 权限表, 用户角色表, 角色权限表的修改以达到对各管理员的角色权限的管理。