系统概要设计说明书范例.docx
《系统概要设计说明书范例.docx》由会员分享，可在线阅读，更多相关《系统概要设计说明书范例.docx（16页珍藏版）》请在冰点文库上搜索。
系统概要设计说明书范例
概要设计说明书
1引言
1.1编写目的
【阐明编写概要设计说明书的目的，指明读者对象。
】
本文档的编写目的是根据项目需求说明书，阐述系统结构，数据定义，接口设计等内容…【展开补充】
1.2项目背景
应包括
●项目的委托单位、开发单位和主管部门
●该软件系统与其他系统的关系。
1.3定义
列出本文档中所用到的专门术语的定义和缩写词的愿意。
1.4参考资料：
●列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源
●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；测试计划（初稿）；用户操作手册
●文档所引用的资料、采用的标准或规范。
2任务概述
2.1目标
【系统目标的描述，系统将要为用户提供什么样的服务，将文字补充丰富】
系统将为三种角色用户提供服务，分别是老师、管理员、学生。
将系统需要的功能按照三种角色要求可归纳为下图的功能结构图：
在上面的功能结构图中，其中老师模块实现的功能包括：
●教师可以进入系统修改自己的资料。
●教师可查看别的老师申报的课题。
●教师可以申报毕设课题。
●教师可以筛选学生填报的本人的志愿。
管理员模块的功能：
●管理员可以进入系统审核教师申报的课题，并且将审核通过的课题向学生开放，将审核未过的课题退回教师重新修改。
●在教师学生互选过程进行到一定时间阶段，管理员可以将未选课题和未定题学生进行随机匹配。
●管理员可以对选题结果进行统计生成报表，并将报表通过教务系统开放接口提交。
学生模块的功能：
●学生可以进入系统浏览搜索查看已向学生开放的课题。
●学生可以选择专业对口的课题进行收藏。
●学生可以从收藏的课题中填报10个课题志愿。
●学生可以查看选题状态和结果。
2.2需求分析
【用例分析的结果（用例图和用例描述）】
根据上面需要实现的系统目标，可以画出以下用例图表达：
对用例图中各业务用例，说明如下：
2.2.1申报课题
●目标
本用例的目标是由教师填写课题相关信息申报课题。
●事件流
教师申报课题的基本业务流程如下：
1）由教师填写课题资料，资料包括：
课题编号、课题名称、课题类型、课题面向专业、课题工作内容、课题对学生要求。
2）教师提交课题，通过数据验证后，将合格的课题提交到课题数据库（数据文件）中，将验证不合格课题返回修改。
3）向用户输出提示信息现实操作结果。
●特殊需求
本操作必须由教师身份的用户执行。
●前置条件
操作之前，教师必须使用用户名密码登录。
●后置条件
2.2.2筛选志愿
●目标
本用例由教师选择自己所出课题的毕设学生。
●事件流
教师筛选志愿的基本业务流程如下：
4）教师查看所属课题的志愿选择状态和统计，包括：
每个课题的当前状态（开放和关闭），选择当前课题的所有志愿，选择当前课题的学生状态。
5）教师从选择课题的志愿中，选取一个状态为尚未定题的学生，确定其为当前课题选题人。
6）将课题与选题人提交，写入数据库（数据文件）。
7）修改课题状态为已选关闭，修改填写本课题的其它志愿状态为落选。
8）修改本课题选题人的当前志愿为中选，修改选题人的其它志愿为自动取消。
●特殊需求
本操作必须由教师身份的用户执行。
●前置条件
操作之前，教师必须使用用户名密码登录。
筛选志愿的课题必须处于开放状态。
被选学生必须填报了该课题志愿，并且学生状态为未选定课题。
●后置条件
2.3条件与限制
3总体设计
根据用例分析中系统功能需求，系统整体业务流程如下（活动图）：
【根据用例分析中的功能需求，组织我们的业务流程】
系统业务分成三个模块实现，如下图（包图）所示：
3.1教师模块
根据教师模块功能，教师模块所包含的类有：
教师类
教师记录操作
教师申报界面类（对应的需求说明中界面流程设计）
教师筛选界面类
类图：
模块主要业务描述（时序图或活动图）
3.2学生模块
3.3管理员模块
类抽象
类图
管理员模块的主要业务：
（时序图，或者活动图）
3.4整体结构
【对模块的设计进行整合】
系统类的抽象
类图的优化合并
各功能操作类根据层次原则组成整体系统结构。
【从垂直方向将系统结构按照功能划分，然后在水平方向按照层次结构合并和组合同一层次的模块（包）或类，形成一个垂直划分和水平划分相结合的体系结构。
】
【可以是一个包图，由于设计时分的不够详细，用方框表示】
4数据结构设计
从需求说明书中表态数据、动态数据、数据词典形成规范的数据结构设计
●表结构
数据库的定义规则
字段
类型
约束
描述
备注
name
Varhcar（120）
Notnull
姓名
教师表（Teachers）
字段
类型
约束
描述
备注
TID
VARCHAR（20）
NOTNULL
教师工号
主键
name
Varhcar（120）
Notnull
姓名
DEPART
VARCHAR（20）
系
COLLEGE
学院
学生表（STUDENTS）
字段
类型
约束
描述
备注
SID
VARCHAR（20）
NOTNULL
学号
主键
name
Varhcar（120）
Notnull
姓名
DEPART
VARCHAR（20）
系
COLLEGE
学院
●数据文件
1）教师信息文件
工号，姓名，学院，系，专业，教授课程；
00001111，张三，信息学院，电子信息，软件工程；
00001112，李四，建设学院，土木工程，桥梁；
2）学生信息文件
3）管理员文件
4）课题文件
5）志愿文件
数据文件名：
ini配置格式
[配置节]
配置项名=配置项值
Xml
1）教师信息文件
2）学生信息文件
3）管理员文件
4）课题文件
5）志愿文件
ini配置文件
[节点]
key=value
●动态数据
https:
//
动态交易密钥
5功能模块设计
5.1外部接口：
【包括用户界面、软件接口与硬件接口。
】
与教务系统提交选题统计报表
写明如何使用此外部接口
5.2内部接口（模块）
由系统整体结构图（系统类图）从垂直或水平方向的模块划分来设计模块。
5.2.1教师类（Teacher）
1）课题申报
+/-/#intProjectApply（stringprjname,stringprjmajor,stringprjdesc,stringprjdemand…）
◆输入
参数分析
◆输出
返回结果
◆处理
处理流程，复杂业务可使用时序图
◆约束
2）志愿筛选
intAppSelect（string,int,….）
◆输入
参数分析
◆输出
返回结果
◆处理
处理流程，复杂业务可使用时序图
◆约束
5.2.2课题类（Project）
做课题类分析时，可以为课题类建立状态图。
1）课题添加
intAdd（….）
◆输入
参数分析
◆输出
返回结果
◆处理
处理流程，复杂业务可使用时序图
◆约束
2）课题开放
intOpen（username,projectid）
◆输入
参数分析
◆输出
返回结果
◆处理
处理流程，复杂业务可使用时序图
◆约束
3）课题关闭
intClose（）
◆输入
参数分析
◆输出
返回结果
◆处理
处理流程，复杂业务可使用时序图
◆约束
6运行设计
6.1运行模块的组合
组件图做组件设计
6.2运行控制
6.3运行时间
7安全保密设计
【描述保障系统安全的方法，从防止非授权访问，防止数据泄露，防止攻击，防止灾难性后果等方面】
登录/权限
备份恢复
8维护设计
说明为方便维护工作的设施，如维护模块等。
补丁升级策略
远程协助／远程登录管理
升级会员 