详细设计文档(final)

1. 引言

1.1编写目的

本部分旨在阐明编写详细设计的目的,面向读者对象。

本文档主要描述各个模块的细节设计,明确软件的结构与实现过程,分析各个模块,描述模块的功能、性能和结构等方面包括模块接口、调用关系、处理过程和算法,以及各个模块的测试方案。本文档的主要读者为软件设计人员、模块开发人员、管理人员、测试人员。

1.2项目背景

我们通过调查问卷的方式,调查了华农部分学生,结果显示参加调查的50%以上的学生有查找空教室,蹭课,约自习需求。经过讨论权衡分析最终确定以该想法----华中农业大学空教室查询作为项目主题,并在此基础上进行功能拓展:经过约自习、蹭课,以微信小程序为应用平台,为华农全体学生提供便利的空教室查询途径。  

1.2.1项目来源

该项目起初源自Triple兔小组一名成员的想法。

1.2.2项目实现

本项目由Triple兔小组成员共同实现。

1.3缩写定义

华农:华中农业大学。

Triple兔:华中农业大学信息学院triple兔软件工程小组。

1.4术语定义

无。

1.5参考资料

[1]窦万峰.软件工程与实践[M].北京:机械工业出版社,2017.

1.6版本信息


修改编号


修改日期


修改后版本


修改位置


修改内容概述


1


2019-5-17


1.0


全部


完成第一次编写

2.总体设计

本部分简要给出系统的需求和软件结构组成,以便追踪到需求与设计。

2.1需求概述

自习吧小程序的需求定义如下:

初始化设置:设置用户登录后的初始页面为查空教室页面。

用户发布邀约设置:在发出邀约之前,必须填写个人资料。

2.2软件结构

自习吧小程序流程图经过优化设计,得出模块层次结构适中的软件总流程图如下:

3.程序描述

本部分针对每一个模块进行详细设计。

3.1登录模块

3.1.1 模块说明如下:

小程序授权登录,获取用户个人信息,进入小程序

3.1.2算法

后端算法描述:

前端算法描述:

3.1.3程序逻辑

3.2 查询空教室模块

3.2.1 模块说明如下:

输入:教学楼信息(几栋教学楼,哪座,几层)

输出:当前楼层的教室信息

功能:查询指定教学楼楼层的教室信息(空闲或者有课)

性能:要求在0.5秒以内完成

3.2.2算法

查询空教室模块调用以下模块完成相应功能:

查询指定教学楼楼层的空闲教室

调整数据格式

后端算法描述:

前端算法描述:

3.2.3程序逻辑

3.3蹭课模块

3.3.1  模块说明如下:

输入:课程名,教师名,专业名(三选一)

输出:课程信息

功能:查询想要上的课程的具体信息

性能:要求在0.5秒以内完成

3.3.2  算法

蹭课模块调用以下模块完成相应功能:

(三选一)

根据课程名查询相应课程信息

后端算法描述:                                                前端算法描述:

根据教师名查询该教师教授的课程

后端算法描述:                                                前端算法描述:

根据专业名查询该专业本学期上的课

后端算法描述:                                                前端算法描述:

补充:其他算法:

3.3.3  程序逻辑

3.4约自习模块

3.4.1 模块说明如下:

输入:用户约自习请求信息

输出:在“广场”页面上对所有人显示该请求

功能:用户输入的约自习请求,在数据库中保存相应请求的信息,并在“广场”页面上对所有人可见,在“我的”页面可查看、删除或编辑用户个人发布的邀约。

性能:要求在0.5秒以内完成

3.4.2算法

蹭课模块模块调用以下模块完成相应功能:

接收用户输入的信息

数据库存储

数据库信息显示

主要功能描述:1.发布约自习   2.查看仔细邀约内容   3.检索自习邀约内容

后端算法描述:

前端算法描述:

3.4.3程序逻辑

3.5测试要点

主要测试输入输出接口是否正确,以及模块内部调用关系是否正确。

原文地址:https://www.cnblogs.com/Triple2/p/11073765.html

时间: 2024-10-14 14:17:14

详细设计文档(final)的相关文章

软工后续工作——增加数据库(详细设计文档4.0)

说明:主要改动就是在3.0的基础上增加了部分游戏数据库. 由于图片不能复制过来,源文档可进入github博客中查看https://github.com/momo23333/Alicization/tree/Zhang 下面为纯文本复制粘贴的内容: 详细设计文档 项目名称:英雄达拉崩吧 小组名称:Scientific_ZEAL软工小分队 项目负责人:刘帅 小组成员:房渤萱 张赐 宋从智 冯惠妍 1.   引言 1.1编写目的 本部分旨在阐明编写详细设计的目的,面向读者对象. 本文档主要描述各个模块

银企支付-详细设计文档

目录 银企支付-详细设计文档 1.定义说明 2.借款单 3.报销单 4.银企互联 5.执行流程日志 6.监控 7.差错处理 8.数据库设计 银企支付-详细设计文档 本文介绍企业在借款单,报销单走银企支付流程时的详细设计.本文重点介绍整个流程需要关注的细节点,在最终实现时,对于数据表具体字段,不做介绍. 1.定义说明 报销金额:申请报销人,填写的当次需要报销的总金额. 借款金额:申请借款人,填写的当次需要借款的金额. 核销金额:指在报销时,本身又存在借款金额未还时,报销中,自动还款的金额,称为核销

树屋详细设计文档

目    录 1. 引言... 3 1.1 编写目的和范围.. 3 1.2 术语表... 3 1.3 参考资料... 4 1.4 使用的文字处理和绘图工具... 4 2. 全局数据结构说明... 4 2.1 常量... 5 2.2 变量... 5 2.3 数据结构... 5 3. 模块设计... 8 3.1 用例图... 8 3.2 功能设计说明... 9 3.2.1 模块1. 10 3.2.2 模块2. 16 4. 接口设计... 26 4.1 内部接口... 26 4.2 外部接口... 2

网络资源收集工具详细设计文档

1.引言 1.1编写目的 将之前会议中记录的设计要点进行总结和规划,供团队内开发者和测试人员进行代码编写与测试. 1.2项目背景 软件名: 网络资源收集工具 本软件任务:为下一组元数据抽取和整理工具进行对接,为下一组提供其所需的各类海量数据. 2.总体设计 2.1需求概述 将35w+个符合条件的网页,问答,文章放入数据库,具体请参见需求文档. 2.2软件结构 3.程序块ConnectServer描述 3.1功能 连接数据库服务器,进行插入以及查询数据库操作. 3.2性能 快速打开和关闭数据库连接

Atitit 项目文档规范化与必备文档与推荐文档列表

===========比较重要的必备文档========== 项目组名单通讯录( 包括项目组,客户沟通人等 需求文档 原型ui文档 开发计划表 项目源码与架构文档以及新结构文档 设计文档 (一般概要即可,重点模块单独详细设计) 数据库文档 注意事项 =========对开发比较重要的文档 Svn源码服务器账号密码 测试数据库账号密码信息 数据库sql脚本文件. 开发环境搭建文档 项目技术规范文档.(项目模式和产品模式有很多不同,需要单独分离) ======其他 测试说明文档 测试服务器部署账号信

项目过程中各阶段应交付的文档

需求阶段 功能分析<详细功能分析书> 功能用例<UAT用例> 旧系统代码分析攻关<代码关键点分析书> 数据库分析<数据库字典> 设计阶段 设计原型<Axure原型图> 框架选型<框架体系结构图> 菜单导航.部门用户.角色权限.操作权限.系统日志.UI框架.报表组件.跨平台方案.WebAPI.数据访问 业务层设计<详细设计文档> 数据库设计<PD文档> 开发计划安排<开发进度WBS> 开发阶段 从源数

让你提前认识软件开发(40):既要写好代码,又要写好文档

第3部分 软件研发工作总结 既要写好代码,又要写好文档 对于软件相关行业,在学校或单位上,大家也许都已经注意到了,除了要编写的程序.绘制设计图之外,还有一个重要的工作便是写文档.为什么要写文档呢?因为我们要把自己做的东西展示出来,不光展示给同行看,可能还要展示给其他岗位上的工作人员看,甚至展示给用户看.如果我们只是会写程序,不会在文档中描述自己的想法,那么就真正的成为"码农"了. 工作也有一段时间了,我发现周围的同事,会写高质量文档的确实很少.李开复老师在<浪潮之巅>的序言

程序员如何写出一份好的文档?

写文档的重要性 对于软件相关行业,在学校或单位大家也许都已经注意到了,除了要编写的程序.绘制设计图之外,还有一个重要的工作便是写文档.为什么要写文档呢?因为我们要把自己做的东西展示出来,不光展示给同行看,可能还要展示给其他岗位上的工作人员看,甚至展示给用户看.如果我们只是会写程序,不会在文档中恰当且优雅地描述自己的想法,那么就真正的成为“码农”了. 我注意了一下,周围的同事会写高质量文档的确实很少.李开复老师在<浪潮之巅>的序言中说到:“我认识很多顶尖的工程师,但具备强大叙事能力的优秀工程师,

软件设计文档及数据流向图

1 数据流向图:张涛 033  2 软件设计结构图:马冀伟 034 3 软件概要设计详细设计文档:王树才  030 一:数据流向图 二:软件设计结构图 三: 软件概要设计详细设计文档 项目名称:  基于服务器的购物系统 1 数据层: 产生的数据有:物品的基本信息,包括名称, 数量,价格,类别,说明,图片:订单信息,包括订单提交时间,订单详情,订单失效时间:用户信息,包括用户名,登录密码,登录时间: 用户上传自己数据:物品名称,数量,价格,类别,说明,图片,用户手机号. 2 整体结构 1 用户登录