学生信息管理系统概要设计说明书

学生信息管理系统概要设计说明书
学生信息管理系统概要设计说明书

学生信息管理系统

姓名:李燃组

任课老师:夏晨洋

课程:技术文档写作与沟通日期: 2017年6月24日

目录

1. 引言 (4)

1.1. 编写目的 (4)

1.2. 项目背景 (4)

1.3. 定义 (4)

1.4. 参考资料 (5)

2. 项目计划 (5)

2.1工作内容 (5)

2.2产品 (6)

2.2.1程序 (6)

2.2.2文档 (6)

2.3运行环境 (6)

2.4服务 (7)

2.5验收标准 (7)

2.5.1代码的验收 (7)

2.5.2 文档验收 (7)

2.5.3 服务验收 (8)

3. 实施计划 (8)

3.1. 任务分解 (8)

3.1.1. 调研和需求分析 (8)

3.1.2. 系统设计 (8)

3.1.3. 编码及测试阶段 (8)

3.1.4. 项目总结 (9)

3.2. 预算 (9)

3.2.1. 学生信息管理系统总预算 (9)

3.3. 关键问题 (9)

4. 人员组织及分工 (10)

4.1. 组织结构和人员分工 (10)

4.1.1. 组织结构 (10)

4.1.2. 人员分工和职责 (11)

5. 交付期限 (12)

6. 项目SSR (12)

7. 需求规格说明 (13)

7.1. 目标 (13)

7.2. 运行环境 (13)

7.3. 假定和约束 (14)

7.4. 对功能的规定 (15)

7.5. 性能的规定 (21)

7.5.1. 精度 (21)

7.5.2. 时间特性要求 (21)

7.5.3. 灵活性 (21)

7.6. 输入输出要求 (21)

7.7. 故障处理要求 (22)

7.8. 设备 (22)

7.9. 支持软件 (22)

8. 总体设计 (22)

8.1. 需求规定 (23)

8.2. 基本设计概念和处理流程 (24)

8.3. 结构 (27)

8.4. 人工处理过程 (29)

8.5. 尚未解决的问题 (29)

8.6. 接口设计 (29)

8.6.1. 用户接口 (29)

8.6.2. 外部接口 (30)

8.6.3. 内部接口 (30)

8.6.4. 运行设计 (31)

8.6.5. 运行模块的组合 (31)

8.6.6. 运行控制 (32)

8.6.7. 运行时间 (32)

8.7. 系统数据结构设计 (32)

8.7.1. 逻辑结构设计要点 (32)

8.7.2. 物理结构设计要点 (33)

8.7.3. 数据结构与程序的关系 (34)

8.7.4. 补救措施 (35)

8.7.5. 系统维护设计 (35)

9. 小组评分 (36)

9.1. 各分项目组职责: (36)

9.2. 打分 (36)

1.引言

1.1.编写目的

从该阶段开发正式进入软件的实际开发阶段,本阶段完成系统的大致设计并明确系统的书籍、u结构与软件结构。在软件设计阶段主要是把一个软件需求转换为软件表示的过程,这种表示只是描绘出软件的总的概貌。本概要设计说明书的目的就是进一步细化软件设计阶段得到的软件总体概貌,把它加工成灾程序细节上非常接近于源程序的软件表示。

1.2.项目背景

(1)本项目的名称是;学生信息管理系统。

(2)本项目的任务提出者是老师,开发者是电子信息科学学院,用户是江夏学院广大师生。

1.3.定义

在该概要设计说明书中的专门术语有:

总体设计

接口设计

数据结构设计

出错设计

具体的概念与含义在文档后将会解释。

1.4.参考资料

(1)学生信息管理系统需求说明书

(2)引用资料

【1】王宜贵,软件工程。北京:机械工业出版社,2008

【2】.张海藩,软件工程导论,北京,清华大学出版社,2005 【3】. 《软件工程导论》第五版张海藩编著清华大学出版社

2.项目计划

2.1工作内容

此次设计我们使用Java编程,实现了学生信息管理系统的过程。本系统采用Sun公司的j2sdk1.4.2_04和SQL server 2000数据库管理系统作为开发工具,通过对学生信息管理系统进行可行性分析、需求分析和设计逐步将一个学生信息管理系统的开发过程呈现出来。

系统开发目标:开发一套可以做到对学生信息的规范管理、科学统计和快速查询的系统,提高学生管理工作的效率。

该软件开发要满足学校对学生信息的科学化化管理的需要,传统人工的方式管理文件档案,存在着许多缺点,效率低、保密性差,随着时间的增加,将产生大量文件和数据,对于查找、更新和维护都带来不少困难。因此该系统特别注重效率的提高和易用性,将学生信息的管理和计算机软件有机的结合在一起,具有学籍信息的输入,学生信息的查询和修改,课程信息的输入、查询和修改,课程的设置和修改,成绩信息的输入、修改、查询和统计,不需重复录入数据,不增加额外人员,优化管理流程,操作应简单,功能强大,实用性强。

该软件应贯穿了学生信息的全面管理,其它各版仅包含对应功能模块。各模块既可结合使用又可独立运行,充分满足客户的不同需求。

该系统包含的子系统有:学生信息管理子系统、课程信息管理子系统、信息查询子系统、成绩管理子系统

主要功能包括:学籍信息的输入,学生信息的查询和修改,课程信息的输入、查询和修改,课程的设置和修改,成绩信息的输入、修改、查询和统计。功能模块包含如下:学生信息管理(学生信息增加、学生信息修改、学生信息删除),课程信息管理(课程信息删除、课程信息修改、课程信息添加),信息查询(学生信息查询、课程信息查询、成绩查询),成绩管理(成绩增加、成绩修改)。

2.2产品

2.2.1程序

(1)交付系统的名称:学生信息管理系统(学生信息管理子系统、课程信息管理子系统、信息查询子系统、成绩管理子系统);

(2)使用的语言:Java

(3)数据库:SQL Server 2000

2.2.2文档

(1)可行性分析报告

(2)软件项目计划书

(3)需求规格说明书

(4)概要设计说明书

2.3运行环境

硬件环境:

CPU:PIII750或者更高频率

ROM:256M或者更高内存支持

磁盘:8G

软件支持:

开发所用的操作系统:Windows XP

开发工具:Eclipse

数据库系统:Microsoft SQL Server 2000

2.4服务

计划提供以下服务:

(1)课堂培训:以讲课形式对客户进行培训,使其能够正确使用软件。

(2)软件安装:负责安装总公司服务器和直属部门终端,并进行相关的配置。

(3)免费咨询:客户可以在工作时间向技术人员提出问题并获得解答。

(4)技术支持:对于某些客户,采取上门指导的方式。

(5)软件维护:获取软件使用中的问题,提供补丁程序。

(6)升级通知:在软件新版本发布的时候,及时通知(电话、Email、邮寄信件)注册的用户,并提供试用版本。

(7)软件升级:对于注册用户,只需较少的费用即可升级到新的版本。

2.5验收标准

2.5.1代码的验收

(1)小组内评审评审报告(优秀)

(2)期末总体评审评审报告(优秀)

(3)代码编写符合HB6465标准

(4)与文档说明保持一致

(5)代码书写风格统一

(6)基本没有下列错误:由于软件缺陷造成丢失数据,不符合设计要求,响应时间太长无法接受。

2.5.2 文档验收

(1)小组内评审

(2)期末总体评审

(3)文档格式符合HB6465标准

(4)功能符合与客户的合同要求

(5)清晰易读,没有语病与歧义

2.5.3 服务验收

(1)服务硬件达到文档说明的要求

(2)人员技术考核合格

3.实施计划

3.1.任务分解

学生信息管理系统,开发工作分五个主要阶段进行。

3.1.1.调研和需求分析

需求分析是整个设计中最重要的一环,当可行性分析完成,项目立项,确定开发角色后,从2017年4月10日开始至2017年4月27日,有关的设计开发人员与相关业务人员共同对业务流程、管理方式进行分析,并进行调研资料的收集、整理。在完成了对有关数据信息的收集、归纳和分析整理后,确定了用户需求,对软件必须完成的功能进行了定义,在此基础上完成了数据定义,建立了数据字典。

3.1.2.系统设计

从2017年4月28日开始至5月7日,完成对整个系统的分析设计,对概念模型、存储模式、完整性控制、存取权限等进行了定义,对系统功能各模块进行了详细设计,定义了数据库总体结构、编码命名规范,定义测试用例。

3.1.3.编码及测试阶段

从5月8日开始至6月1日,完成程序设计和系统测试,完成了

数据库建立及程序的编制调试。为了避免错误累积,采用边开发边测试的基本模式,对每个模块都安排专人进行单独测试。系统联调及系统测试,对系统处理逻辑、例外处理能力、容错能力等进行大规模的测试,对发现的问题进行彻底纠正。

3.1.

4.项目总结

从6月1日开始至6月3日项目结束,用3左右时间,对项目研发、部署等开发过程中的问题、经验教训总结备案,以利于项目经验的积累和开发进度的缩短。

3.2.预算

3.2.1.学生信息管理系统总预算

3.3.关键问题

1.人员影响本计划完成的主要问题有:

(1)用户需求不清,存在误解及二义性;

(2)工作人员有教学和科研任务,投入全部的时间和精力,没有足够的开发时间;

解决方案:

(1)项目需求说明书要求语言准确、规范,并由用户确认,纳入软

件质量管理;

(2)项目组成员需认真遵守项目开发的相关规定,分工明确,实行进度跟踪和控制,质量控制的项目小组负责制。

2.技术因素:

(1)部分技术成熟度不够;

(2)开发与管理工具选择可能不当影响进度;

(3)项目测试可能不充分或不严谨。

(4)软件的部分集成可能有矛盾。

解决方案:

(1)采用现已成熟的先进技术,对部分技术难题加快研究进度,可引用第三方技术相对成熟和稳定的插件;

(2)实行严格的项目质量控制、进度控制和评估,确保开发质量和进度;

(3)根据软件的需求设计测试用例,对每一模块进行单元测试,书写测试报告,进行测试的评估;

(4)设计公用的接口,规范接口定义;

4.人员组织及分工

4.1.组织结构和人员分工

4.1.1.组织结构

该项目设项目组长一名,秘书一名,总设计师一名,系统分析员一名,分析员一名,技术员两名:

(1)项目组设组长一名:段宛露

(2)秘书一名:

(3)总设计师一名:

(4)系统分析员一名:

(5)分析员一名:

(6)技术人员两名:

根据系统的实际需要,项目组分为总体组,学信组、课信组、信息查询组和成绩管理组五个小组。

4.1.2.人员分工和职责

1.组长(段宛露)职责:

(1)制定总体工作方案,定义软件开发过程;

(2)制定岗位职责,分工及开发纪律;

(3)提供开发工作需要的物质与环境保障;

(4)与用户方管理层就整体目标、合作内容、合作方式等进行协调;(5)定期分析工作进展状况,针对存在的问题提出改进建议;(6)研究学生信息管理关键技术,提出关键问题解决方案。

(7)组织制定项目设计的技术路线;

(8)设计管理及安全控制策略;

(9)围绕关键技术组织项目申报,并具体指导研究工作的开展;(10)宏观控制软件开发进程与开发质量;

(11)人员管理,包括开发人员的招聘,管理与动态调整,外聘指导专家。

2.总设计师()及总体组职责:

(1)总设计师负责总体组的各项工作,由xx担任,另包括xx、xx 和xx等;

(2)定期组织业务学习,提供技术支持;

(3)制定技术方案,时间计划,质量控制目标并组织具体实施;(4)针对本项目特点提供规范的开发文档模板,撰写需求分析说明书等文档;

(5)项目开发进程及质量的具体控制;

(6)需求分析,系统设计等各项技术性工作;

(7)组织并带领分析员开展调研,并熟悉每一个子系统的功能需求;(8)具体负责设计,实施及测试等各阶段的工作;

(9)负责各子系统的统一协调与管理;

(10)其他相关事务。

3.各分项目组职责:

学生管理系统

需求分析人员:李斌,宋朝

软件设计人员:李燃,陈毫,何春明

软件测试人员:张大鹏杨之颢杨杰王桔波

分项目组负责相应子系统的需求分析、系统设计、编码、测试及

试运行等相关工作;负责支撑理论与方法研究。5.交付期限

(1)学生信息管理系统交付期限:2017年6月15日(2)相关文档交付期限: 2017年7月1日

6.项目SSR

被接见者:

日期:

时间:

地点:

主题:管理员账户的权限

7.需求规格说明

7.1.目标

A.开发意图:由于学校的不断招生,现有的系统空间小,运行速度缓慢,操作过于复杂,有的操作还不能执行,所以要开发本系统。B.应用目标:学生信息管理系统将解决现有系统的空间不足,运行缓慢,操作复杂,操作无效等问题。

C.作用及范围:本系统运用于江西应用技术职业学院。

7.2.运行环境

本系统采用C/S体系结构

操作系统:Microsoft Windows xp

支持环境:IIS 5.0

数据库:Microsoft SQL Server 2000

软件设备:eclipse 3.2

硬件设备:

服务器:80x86系列微机

CPU:733以上

内存:512 M以上

硬盘空间:40G以上

电脑配置:80x86系列微机

CPU: 233MHZ以上

内存:256M以上

硬盘空间:1.5G以上

7.3.假定和约束

本软件在开发的过程中,分为技术实现与软件工程两大部分,两部分都有侧重点,若技术支持出现故障或疑难问题无法解决、程序开发出现偏差,会延误工程进度,影响工程的按期完工。若软件工程陈述出现问题,部分描述含混不清,则会影响系统的完整性与可继承性。在管理方面,如管理者没有预见性,对出向的问题无法采用可行的解决手段,都会影响开发模块之间的互动,从而影响工程的顺利开展,导致工程无法按期完工。

7.4.对功能的规定

系统流程图:系统流程图是用户操作此系统的流程和各个用户能够操作的功能,如A-1就是一个系统流程图;用户有系统管理员,教师和学生,每个用户要进入此系统都要登录。每个用户有不同的功能,系统管理员有查询,增加,修改,删除,修改密码,设置权限等功能;教师有查询,修改密码和输入学生成绩的功能;学生只有查询和修改密码的功能。

A-1系统流程图

用例图:用例图是用来表示用户能使用的功能和权限。如图A-2表示系统管理员可以运用的功能,像修改密码,管理学生信息、成绩信息、课程信息、班级信息并且设置权限。图A-3表示教师可以运用的功能,如:修改密码和查询信息。A-4表示学生可以运用的功能,如:修改

密码和查询自己信息,查询班级信息,课程信息。

A-2系统管理员的用例图

A-3 教师的用例图

A-4学生的用例图

顺序图和活动图:顺序图是用户做某件事情所需要的相关的事物和用

户执行的

A-5

系统管理员添加学生信息的顺序图

A-6系统管理员添加学生信息的活动图系统管理员查询学生班级信息的顺序图和活动图:

A-7

系统管理员查询班级信息的顺序图

A-8系统管理员查询班级信息的活动图系统管理员删除学生课程信息的顺序图和活动图:

A-9系统管理员删除学生课程信息的顺序图

A-10系统管理员删除学生课程信息的活动图

系统管理员修改学生成绩信息的顺序图和活动图:

A-11系统管理员修改学生成绩信息的顺序图

A-12系统管理员修改学生成绩信息的活动图

概要设计说明书范例及模板

《XXXXXX》概要设计说明书 张三、李四、王五

1.引言 1.1编写目的 在本机票预定系统项目的前一阶段,也就是需求分析阶段中,已经将系统用户对本系统的需求做了详细的阐述,这些用户需求已经在上一阶段中对航空公司、各旅行社及机场的实地调研中获得,并在需求规格说明书中得到详尽得叙述及阐明。 本阶段已在系统的需求分析的基础上,对机票预定系统做概要设计。主要解决了实现该系统需求的程序模块设计问题。包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息,以及数据结构、模块结构的设计等。在以下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。 在下一阶段的详细设计中,程序设计员可参考此概要设计报告,在概要设计对机票预定系统所做的模块结构设计的基础上,对系统进行详细设计。在以后的软件测试以及软件维护阶段也可参考此说明书,以便于了解在概要设计过程中所完成的各模块设计结构,或在修改时找出在本阶段设计的不足或错误。 1.2项目背景 机票预定系统将由两部分组成:置于个旅行社定票点的前台客户程序,以及置于航空公司的数据库服务器。本系统与其他系统的关系如下: 1.3定义 1.3.1 专门术语 SQL SERVER: 系统服务器所使用的数据库管理系统(DBMS)。 SQL: 一种用于访问查询数据库的语言 事务流:数据进入模块后可能有多种路径进行处理。 主键:数据库表中的关键域。值互不相同。 外部主键:数据库表中与其他表主键关联的域。 ROLLBACK: 数据库的错误恢复机制。 1.3.2 缩写

系统:若未特别指出,统指本机票预定系统。 SQL: Structured Query Language(结构化查询语言)。 ATM: Asynchronous Transfer Mode (异步传输模式)。 1.4参考资料 以下列出在概要设计过程中所使用到的有关资料: 1.机票预定系统项目计划任务书浙江航空公司1999/3 2.机票预定系统项目开发计划《**》软件开发小组1999/3 3.需求规格说明书《**》软件开发小组1999/3 4.用户操作手册(初稿)《**》软件开发小组1999/4 5.软件工程及其应用周苏、王文等天津科学技术出版社1992/1 6.软件工程张海藩清华大学出版社1990/11 7.Computer Network A.S.Tanenbaun Prentice Hall 1996/01 文档所采用的标准是参照《软件工程导论》沈美明著的“计算机软件开发文档编写指南”。 2.任务概述 2.1 目标 2.2 运行环境 系统将由两部分程序组成,安装在各旅行社客户机上的客户程序及航空公司内的数据服务器程序。 根据调研得知所有旅行社的计算机配置均在Pentium 133级别以上,客户程序应能够在Pentium 133级别以上, Win NT环境下运行。 2.3 需求概述 浙江航空公司为方便旅客,需开发一个机票预定系统。为便于旅客由旅行社代替航空公司负责为旅客定票,旅行社把预定机票的旅客信息,包括姓名、性别、工作单位、身份证号码、旅行时间、旅行目的地,输入机票预定系统的客户端程序,系统经过查询航空公司内的航班数据服务器后,为旅客安排航班,印出取票通知。旅客在飞机起飞前一天凭取票通知和帐单交款后取票,系统校对无误后即印出机票给旅客。 要求系统能有效、快速、安全、可靠和无误的完成上述操作。并要求客户机的界面要简单明了,易于操作,服务器程序利于维护。 2.4 条件与限制 3.总体设计 3.1 处理流程 下面将使用(结构化设计)面向数据流的方法对机票预定系统的处理流程进行分

软件详细设计方案说明书

xxx项目详细设计说明书 (xxx模块) 拟制日期yyyy-mm-dd 评审人日期 批准日期 签发日期

文档修订记录 版本完成人修改内容审核批准时间V0.00 创建文档

目录 1. 简介5 1.1. 编写目的 (5) 1.2. 适用范围 (5) 1.2.1. 软件名称 (5) 1.2.2. 软件功能 (5) 1.2.3. 软件应用 (5) 1.3. 定义及关键词 (5) 1.4. 参考资料 (5) 2. 子模块1设计描述 (6) 2.1. 类xxx的设计 (6) 2.1.1. 简介 (6) 2.1.2. 类图 (6) 2.1.3. 状态设计(可选) (6) 2.1.4. 属性 (6) 2.1.5. 方法 (6) 3. 数据库详细设计(可选) (9) 3.1.存储过程#/触发器#的名称 (9) 4. 错误处理 (10) 4.1. 系统错误 (10) 4.2. 接口错误 (10) 4.3. 协议错误 (10)

表目录 表1.关键词 (5) 表2.类XXX的属性 (6) 表3.方法描述xxx-function (7) 图目录 图1类图xxx-class (6) 图2流程图xxx-function (7)

1. 简介 1.1. 编写目的 这部分要描述文档的目的,并指明文档的读者。 1.2. 适用范围 1.2.1. 软件名称 1.2.2. 软件功能 解释软件产品将完成或不完成的功能 1.2.3. 软件应用 描述软件的应用领域 1.3. 定义及关键词 表1.关键词 关键词英文全名中文解释 1.4. 参考资料 [1]

2. 子模块1设计描述 2.1. 类xxx的设计 2.1.1. 简介 如果在概要设计中未说明,则在此详细描述类的职责和功能,可使用顺序图、协作图、状态图来详细描述。必要时,可描述本类与相关类之间的静态动态关系。 2.1.2. 类图 图1类图xxx-class 2.1. 3. 状态设计(可选) 可以用状态图来描述类的状态信息。 2.1.4. 属性 可先定义相关的数据结构,再对属性进行描述。 也可以不使用表格、而使用伪代码格式。 表2.类XXX的属性 可见性属性名称类型说明(对属性的简短描述) Private Public Protected 2.1.5. 方法 1. 方法xxx 1) 方法描述 Java的函数头注释采用JavaDoc自动生成的格式: /** * @functions 增删改查XXX * @param String name 名字 * @return true 如果不为空则返回真,false 如果为空返回假 * @throws 无 */ C++使用以下格式:

概要设计说明书实例

1 引言 (3) 1.1 编写目的 (3) 1.2 背景 (3) 1.3 定义 (3) 1.4 参考资料 (3) 2 总体设计 (3) 2.1 简述 (3) 2.2 架构设计 (4) 2.2.1 系统逻辑架构图 (4) 2.2.2 系统物理架构图 (4) 2.2.3 顶层系统包图 (5) 2.2.4 业务类包图 (6) 2.2.5 子系统关系图 (6) 2.3 接口设计 (6) 2.3.1 界面框架设计 (6) 2.3.2 外部接口设计 (7) 3 子系统设计 (7) 3.1 基础信息子系统 (7) 3.1.1 子系统说明 (7) 3.1.2 类图 (8) 3.1.3 类说明 (12) 3.1.4 界面设计 (19) 3.2 我的工作台子系统 (21) 3.2.1 子系统说明 (21) 3.2.2 类图 (22) 3.2.3 类说明 (26) 3.2.4 界面设计 (32) 3.3 工作进展子系统 (33) 3.3.1 子系统说明 (33) 3.3.2 类图 (34) 3.3.3 类说明 (34) 3.3.4 界面设计 (34) 3.4 信息发布子系统 (36) 3.4.1 子系统说明 (36) 3.4.2 类图 (36) 3.4.3 类说明 (37) 3.4.4 界面设计 (38) 3.5 系统管理子系统 (38) 3.5.1 子系统说明 (38) 3.5.2 类图 (39) 3.5.3 类说明 (39) 3.5.4 界面设计 (40) 3.6 个人设置子系统 (41)

3.6.1 子系统说明 (41) 3.6.2 类图 (42) 3.6.3 类说明 (43) 3.6.4 界面设计 (44) 4 约束和假定 (45) 5 系统数据结构设计 (45) 5.1 逻辑结构设计 (45) 5.1.1 角色表(PUBLIC_ROLE) (46) 5.1.2 权限表(PUBLIC_PRIVILEGE) (46) 5.1.3 角色权限表(PUBLIC_ROLEPRIVILEGE) (46) 5.1.4 部门表(PUBLIC_ DEPT) (46) 5.1.5 岗位表(PUBLIC_POST) (47) 5.1.6 员工表(PUBLIC_MEMBER) (47) 5.1.7 工作任务表(WORKPLAN_ TASK) (48) 5.1.8 任务分派表(WORKPLAN_ ALLOTTASK) (48) 5.1.9 工作计划表(WORKPLAN_ PLAN) (48) 5.1.10 计划任务表(WORKPLAN_ PLANTASK) (49) 5.1.11 工作日志表(WORKPLAN_ WORKLOG) (49) 5.1.12 工作汇报表(WORKPLAN_ WORKREPORT) (50) 5.1.13 信息发布表(PUBLIC_ PUBLISHINFO) (50) 5.1.14 收件箱表(PUBLIC_INBOX) (50) 5.1.15 系统操作日志表(PUBLIC_OPERA TELOG) (51) 5.1.16 个人提醒设置表(PUBLIC_EVENTS) (51) 5.1.17 系统表(PUBLIC_SYSTEM) (52) 5.1.18 系统功能模块表(PUBLIC_SYSTEMMODULE) (52) 5.2 物理结构设计 (52) 5.3 数据结构与程序的关系 (52) 6 系统出错处理设计 (52) 6.1 出错信息 (52) 6.2 补救措施 (53) 6.3 系统维护设计 (53)

仪器软件方案设计说明书

软件设计说明书日写:编期:日期:审核:日期:准:批 文档变更记录

一、引言........................................................................................................... - 1 - 1.1 编写目的............................................................................................. - 1 - 1.2 范围..................................................................................................... - 1 - 1.3 定义..................................................................................................... - 1 - 1.4 版本说明............................................................................................. - 1 - 1.5 参考资料............................................................................................. - 1 - 二、项目概述................................................................................................... - 2 - 2.1 产品描述............................................................................................. - 2 - 2.2 产品功能............................................................................................. - 2 - 2.3 用户特点............................................................................................. - 2 - 三、嵌入式软件整体方案设计....................................................................... - 3 - 3.1 子系统控制方案设计......................................................................... - 3 - 3.2 中控板GUI方案设计....................................................................... - 3 - 3.3 数据通信方案设计............................................................................. - 4 - 四、子系统控制方案设计............................................................................... - 5 - 4.1 液路系统控制方案设计..................................................................... - 5 - 4.2 样品采集系统控制方案设计............................................................. - 7 - 4.3 二氧化碳恒温培养箱环境控制环境设计......................................... - 8 - 五、中控板GUI方案设计............................................................................. - 9 - 六、数据通信方案设计................................................................................. - 10 - 6.1 数据链路层通信方式....................................................................... - 10 - 6.2 PC与主控板通信流程设计.............................................................. - 10 - 一、引言

系统概要设计说明书规范

KTV点歌系统概要设计说明书

1. 引言 1.1目的 选歌系统是为某KTV唱吧开发的视频歌曲点唱软件。该软件能方便顾客进行选歌,帮助系统管理员管理歌曲的播放,提高KTV歌曲点唱的效率和准确率。 本文档为该系统的概要设计说明书,详细阐述了对用户所提出需求的设计方案,对系统中的各项功能需求、技术需求、实现环境及所使用的实现技术进行了明确定义。同时,对软件应具有的功能和性能及其他有效性需求也进行了定义。 1.2项目背景 ●系统名称:选歌系统 ●项目提出者:某KTV唱吧 ●项目开发者: ●项目管理者: ●最终用户:某KTV唱吧 1.3术语定义 实现环境:系统运行的目标软件、硬件环境。 实现技术:系统所采用的软件技术或体系结构。 实现语言或工具:实现系统最终采用的编程语言或工具包,如Delphi、VB、PB、Java、Ada等。 参考资料 1)新余电视点播系统; 2)某KTV唱吧《视频点歌系统计划任务书》; 本项目所参照的文件有: 3)康博工作室,《Visual Basic 新起点》,机械工业出版社,2000

2. 系统概述 2.1系统需求 2.1.1系统目标 本软件是为某KTV唱吧开发的视频点歌系统软件。该软件用于提高点歌系统的工作效率。随着人们业余生活的丰富,休闲活动的多种多样,人们更多的喜欢选择KTV这种形式的娱乐方式。且随着计算机普及,点歌系统越来越智能化,人性化;一个好的音乐唱吧必须要拥有一个方便、快捷、准确的点歌系统,因此,急需一个软件系统解决这些问题。本软件应能结合当前选歌播放手工操作的流程以及将来业务发展的需要,对视频点歌系统中歌曲信息、歌手信息、最新排行榜等等的查询、更新提供完全的计算机管理。 2.1.2性能需求 数据精确度 数量值:精确到小数后一位; 时间值:精确到日,并以yyyy/mm/dd的形式表示; 价格值:精确到分,并以.XX的形式表示。 时间特性 页面响应时间:不超过10秒 更新处理时间:不超过15秒 数据转换与传输时间:不超过30秒。 适应性 1) 开发基于的平台要考虑向上兼容性,如操作系统,数据库等要考虑更高版本的兼容 性。 2) 当需求发生变化时系统应具有一定的适应能力,要求系统能够为将来的变更提供以 下支持:能够在系统变更用户界面和数据库设计,甚至在更换新的DBMS后,系统的现有设计和编码能够最大程度的重用,以保护现阶段的投资和保证软件系统能够在较少后续投入的情况下适应系统的扩展和更新。在设计中最好列出针对变更所需要重新设计的模块部分

软件概要设计说明书模版

软件概要设计报告文档模板 1. 引言 (2) 1.1编写目的 (2) 1.2项目风险 (2) 1.3预期读者和阅读建议 (2) 1.4参考资料 (2) 2. 设计概述 (3) 2.1限制和约束 (3) 2.2设计原则和设计要求 (3) 3. 系统逻辑设计 (4) 3.1系统组织设计 (4) 3.2系统结构设计 (4) 3.2.1 系统特性表 (5) 3.2.2 系统特性结构图 (6) 3.3系统接口设计 (6) 3.3.1 系统接口表 (6) 3.3.2 系统接口传输协议说明 (7) 3.4系统完整性设计 (7) 4. 系统出错处理设计 (8) 4.1系统出错处理表 (8) 4.2维护处理过程表 (9) 5. 技术设计 (10) 5.1系统开发技术说明表 (10) 5.2开发技术应用说明 (11) 6. 数据库设计 (11) 7. 词汇表 (11) 8. 进度计划 (11)

1. 引言 引言是对这份软件系统概要设计报告的概览,是为了帮助阅读者了解这份文档是如何编写的,并且应该如何阅读、理解和解释这份文档。 1.1 编写目的 说明这份软件系统概要设计报告是基于哪份软件产品需求规格说明书编写的,开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统概要设计报告详尽说明了该软件产品的软件结构,包括数据库结构和出错处理,从而对该软件产品的结构的描述。 如果这份软件系统概要设计报告只与整个系统的某一部分有关系,那么只定义软件系统概要设计报告中说明的那个部分或子系统。 1.2 项目风险 具体说明本软件开发项目的全部风险承担者,以及各自在本阶段所需要承担的主要风险,首要风险承担者包括: ●任务提出者; ●软件开发者; ●产品使用者。 1.3 预期读者和阅读建议 列举本软件系统概要设计报告所针对的各种不同的预期读者,例如,可能的读者包括: ●用户; ●开发人员; ●项目经理; ●营销人员; ●测试人员; ●文档编写人员; ●等等。 描述文档中,其余部分的内容及其组织结构,并且针对每一类读者提出最适合的文档阅读建议。 1.4 参考资料 列举编写软件产品概要设计报告时所用到的参考文献及资料,可能包括: ●本项目的合同书; ●上级机关有关本项目的批文; ●本项目已经批准的计划任务书; ●用户界面风格指导;

软件概要设计说明书范例

XX概要设计说明书

文档修改记录

填写说明 1. 系统结构的定义 本体系对整个软件系统按如下结构方式进行划分:系统子系统模块子模块 其中: (1)“系统子系统”划分属于“系统设计”,在系统设计说明书中予以描述。 (2)“子系统模块”划分属于“概要设计”,在本说明书中予以描述。 (3)“模块子模块”划分属于“详细设计”,在详细设计说明书中予以描述。如果系统相对简单,可以省略“子模块”这一层次。 2. 如果填写了系统设计说明书,则在本说明书中略过“系统子系统”划分的相关内容(即第2章)。 3. 如果系统相对简单,不需要做“系统子系统”划分,这种情况下,取消填写系统设计说明书,只须填写本说明书,直接套用“子系统模块”划分(即第3章)进行“系统模块”划分(把其中“子系统”一词替换为“系统”),并删除本说明书中“系统子系统”划分的相关内容(第2章)。

目录 1. 简介 ................................................................ 错误!未定义书签。 . 背景和目的.................................................... 错误!未定义书签。 . 范围.......................................................... 错误!未定义书签。 . 术语和缩略语.................................................. 错误!未定义书签。 2. 系统总体设计 ........................................................ 错误!未定义书签。 . 任务概述...................................................... 错误!未定义书签。 目标 .................................................... 错误!未定义书签。 需求概述 ................................................ 错误!未定义书签。 . 设计概述...................................................... 错误!未定义书签。 总体约束 ................................................ 错误!未定义书签。 系统外部接口 ............................................ 错误!未定义书签。 设计方案概述 ............................................ 错误!未定义书签。 . 系统架构设计.................................................. 错误!未定义书签。 系统的逻辑架构设计 ...................................... 错误!未定义书签。 系统的物理架构设计 ...................................... 错误!未定义书签。 . 子系统定义.................................................... 错误!未定义书签。 子系统列表 .............................................. 错误!未定义书签。 子系统间关系 ............................................ 错误!未定义书签。 3. 子系统1设计 ........................................................ 错误!未定义书签。 . 任务概述...................................................... 错误!未定义书签。 目标 .................................................... 错误!未定义书签。 需求概述 ................................................ 错误!未定义书签。 . 设计概述...................................................... 错误!未定义书签。 总体约束 ................................................ 错误!未定义书签。 子系统外部接口 .......................................... 错误!未定义书签。 设计方案概述 ............................................ 错误!未定义书签。 . 子系统架构设计................................................ 错误!未定义书签。 . 模块定义...................................................... 错误!未定义书签。

软件开发具体实施计划方案说明

物资管理系统开发具体实施方案

目录 1软件开发实施方案 (3) 1.1开发流程总述 (3) 1.2软件需求分析 (5) 1.3结构设计 (8) 1.4详细设计 (10) 1.5编码 (12) 1.6模块集成测试 (14) 1.7系统测试 (16) 1.8验收 (17) 1.9维护 (19)

1组织实施步骤 系统开发严格按照软件工程的方法进行组织,系统的开发过程按照需求分析、系统分析与设计要求、系统编码、系统测试几个过程有序推进。下表所示系统开发流程图,采用原型及迭代方式开发,根据用户需求持续改进,直到最终用户确认满意。 1.1实施开发流程总述 如下图示流程定义了我公司内部的软件开发过程,以指导和规范 软件项目中开发过程的定义和相应的实施。 该过程可划分为一系列子过程,包括:软件需求分析、设计、编码、测试、验收、维护,每个子过程又由一系列任务和活动组成,如设计过程又可分为结构设计和详细设计。但是在实际开发项目中,情况仍然会是千变万化的,因此我们也并不是一成不变的死板执行一个僵化的工作流程,我们的原则是在一个规范流程的指导和约束下,根据具体工程项目的实际要求,为每一个项目评估并制定真正能够最好的满足该项目要求的开发流程。

《结构设计说明书》(初稿) 《集成测试计划》《集成测试案例》 (初稿) 《用户手册》(初稿) 《追溯表一》 《结构设计说明书》 《集成测试计划》《集成测试案例》 《个人评审记录》 《评审报告》 N改进 软件需求分析 《软件需求规格说明书》(初稿) 《系统测试计划》《系统测试案例》 (初稿) 《用户手册》(概要) 《追溯表一》 ▼ 同行评审 丫 Y 通过 《软件需求规格说明书》 《系统测试计划》《系统测试案例》 《个人评审记录》 《评审报告》 「 N改进 详细设计 《详细设计说明书》(初稿) 《单元测试计划》《单元测试案例》 (初稿) 《用户手册》(修改稿) 《追溯表一》 评审通过 《详细设计说明书》 《单元测试计划》《单元测试案例》 《用户手册》(修改稿) 《个人评审记录》 《评审报告》— 源代码、源代码文件清单 《单元测试报告》(经过审批) --- ”《软件问题状态登记表》 《软件问题报告单》 《集成工作单》 《集成测试工作单》 《集成测试报告》(经过审批) 《软件问题状态登记表》 《软件问题报告单》 集成的软件系统 《系统测试报告》(经过审批) 《软件问题状态登记表》 《软件问题报告单》 《系统管理员使用说明书》(经过审批) _ 《安装手册》(经过审批) 《用户手册》(经过审批 软件系统(系统测试通过) 验收测试报告 《软件问题报告单》 《软件问题状态登记表》 验收报告 可交付产品 《软件需求规格说明书》(升级版) 《客户需求登记表》 《客户需求统计表》 《设计说明书》(升级版) 《软件问题报告单》 《软件问题状态登记表》 《软件维护实施计划》维 护后的软件系统 软件开发流程总图 结构设计 评审通过

软件概要设计

XX 概要设计说明书

目录

错误!未找到引用源。 关键词:能够体现文档描述内容主要方面的词汇。 摘要: 缩略语清单:对本文所用缩略语进行说明,要求提供每个缩略语的英文全名和中文解释。

1简介 1.1 目的 这部分要描述文档的目的。应该指明读者。 1.2 范围 1.2.1 软件名称 对软件命名 1.2.2 软件功能 解释软件产品将完成或不完成的功能(可以直接描述也可以参考相关文档) 1.2.3 软件应用 描述软件的应用(可直接描述也可以参考其他软件文档) 1.3实现系统环境 描述本软件的硬件应用平台(主要涉及关键器件的介绍和环境组网方式) 1.3.1 器件特性描述 本器件所支持的规格、工作模式及其异同 1.3.2 器件工作原理介绍 The description of the work principle of the device we used in our solution. 1.3.3 关键寄存器介绍 The description of the registers used in the work mode our solution. 2概要设计 2.1第0层设计描述 2.1.1 软件系统上下文定义 描述系统如何与外部实体一道组成功能实体(一般用图描述)

外部实体属性描述只限于软件设计和描述相关的属性。 2.1.2 设计思路(可选) 2.1.2.1基本设计思路 说明系统采取的基本设计思路,概要描述为什么采取本方案。 2.1.2.2设计约束 1遵循标准 描述本软件所遵循的标准、规范 2硬件限制 描述本软件系统实现的硬件限制 3技术限制 描述本软件的技术限制 2.1.2.3安全性和可靠性设计方案 4遵循标准 描述本软件所遵循的标准、规范 5硬件限制 描述本软件系统实现的硬件限制 6技术限制 描述本软件的技术限制 2.1.2.4其他 描述其他有关的设计考虑 2.2第一层设计描述 2.2.1系统架构(功能分解和物理分解) 描述组成软件系统的构件(子系统、模块),描述之间的“静态”关系。一般采用系统方框图的形式。要按照子系统组成系统,模块组成子系统的方式组织描述。 系统方框图应能规定出系统的整体架构,说明组成系统的各部分是如何搭配成一个完整系统的。 系统方框图应画成二种: 一种是功能性的,说明系统有哪些功能应由哪些功能模块来实现画出这些功能模块之间、本系统与其它接口系统之间的逻辑关系;描述它们间的接口方式,遵循的协议规范等。如果是升级类产品,在原有功能方框框图上增加、删除、修改。 另一种是物理性的,说明系统由具体的哪些软件模块来实现。

概要设计说明书示例【概要设计说明书(模板)】

概要设计说明书示例【概要设计说明书(模板)】 概要设计说明书 修订记录 目录 第一章 1.1.1. 2.1. 3.1. 4.第二章 2.1.2.2.2. 3.2. 4.2. 5.2. 6.2. 7.第三章 3.1.3.2.3.3.第四章 4.1.4.2.4.3.第五章 5.1.5.2.5.3.第六章 6.1. 6.2.6.3. 补救措施......................................................... ........................................10系统维护设计......................................................... .. (10) 第一章引言 1.1.编写目的 说明编写这份概要设计说明书的目的,指出预期的读者。 1.2.背景 说明:

a.待开发软件系统的名称; b.列出此项目的任务提出者、开发者、用户以及将运行该软件的站点。 1.3.定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4.参考资料 列出有关的参考文件,如: a.本项目的经核准的计划任务书或合同,上级机关的批文; b.属于本项目的其他已发表文件; c.本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出 第二章总体设计 2.1.需求规定 说明对本系统的主要的输入输出项目、处理的功能性能要求。 2.2.运行环境 简要地说明对本系统的运行环境(包括硬件环境和支持环境)的规定。 2.3.基本设计概念和处理流程 说明本系统的基本设计概念和处理流程,尽量使用图表的形式。 2.4.结构 用一览表及框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系。 2.5.功能需求与程序的关系

软件设计说明书

软件设计说明书 1引言 1.1编写目的 说明编写详细设计方案的主要目的。 说明书编制的目的是说明一个软件系统各个层次中的每个程序(每个模块或子程序)和数据库系统的设计考虑,为程序员编码提供依据。 如果一个软件系统比较简单,层次很少,本文件可以不单独编写,和概要设计说明书中不重复部分合并编写。 方案重点是模块的执行流程和数据库系统详细设计的描述。 1.2背景 应包含以下几个方面的内容: A. 待开发软件系统名称; B. 该系统基本概念,如该系统的类型、从属地位等; C. 开发项目组名称。 1.3参考资料 列出详细设计报告引用的文献或资料,资料的作者、标题、出版单位和出版日期等信息,必要时说明如何得到这些资料。 1.4术语定义及说明 列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。 2设计概述 2.1任务和目标 说明详细设计的任务及详细设计所要达到的目标。 2.1.1需求概述 对所开发软件的概要描述, 包括主要的业务需求、输入、输出、主要功能、性能等,尤其需要描述系统性能需求。 2.1.2运行环境概述

对本系统所依赖于运行的硬件,包括操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述,及配置要求。 2.1.3条件与限制 详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。 2.1.4详细设计方法和工具 简要说明详细设计所采用的方法和使用的工具。如HIPO图方法、IDEF(I2DEF)方法、E-R图,数据流程图、业务流程图、选用的CASE工具等,尽量采用标准规范和辅助工具。3系统详细需求分析 主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认,并对由于情况变化而带来的需求变化进行较为详细的分析。 3.1详细需求分析 包括: ?详细功能需求分析 ?详细性能需求分析 ?详细资源需求分析 ?详细系统运行环境及限制条件分析 3.2详细系统运行环境及限制条件分析接口需求分析 包括: ?系统接口需求分析 ?现有硬、软件资源接口需求分析 ?引进硬、软件资源接口需求分析 4总体方案确认 着重解决系统总体结构确认及界面划分问题。 4.1系统总体结构确认 对系统组成、逻辑结构及层次进行确认,对应用系统、支撑系统及各自实现的功能进行确认,细化集成设计及系统工作流程,特别要注意因软件的引进造成的系统本身结构和公司其他系统的结构变化。包括:

在线交易二手市场系统概要设计说明书

在线交易二手市场系统概要设计说明书概要设计说明书 信息与电气工程学院 软工1401 ** 201422******

1.引言 1.1编写目的 此概要设计说明书实现一个简易的基于校园网在线交易二手市场系统,对交易管理系统的总体设计、接口设计、界面总体设计、系统出错处理设计以及系统安全数据进行了说明,在以后的软件测试以及软件维护阶段也可参考此说明书,以便于了解在概要设计过程中所完成的各模块设计结构,或在修改时找出在本阶段设计的不足或错误。 1.2背景 A.待开发软件系统名称为: 在线交易二手市场; B.任务提出者:** 开发者:** C.使用用户能在校园网上进行交易的系统。 D. 按照《在线交易二手市场系统需求分析说明书》为基础来具体细化系统所具备的所有功能及功能的实现方法和接口。 1.3 开发环境 Visual Studio 2010 Mircosoft sql server 2008 Express

PowerDesigner 15.1 1.4定义 本系统:基于校园网的在线交易二手市场系统设计与实现 1.5参考资料 《基于校园网在线交易二手市场需求分析说明书》 《项目计划表》 《校园网在线交易二手市场系统_数据库模型》 2.总体设计 2.1设计目标 基于校园网的在线交易二手市场主要实现以下目标: ⑴为师生提供展示商品及表现学校形象的平台。 ⑵为用户提供商品信息查看、在线商品订购、商品浏览等功能。 ⑶采用动态网页技术,使页面中展示的商品信息更具时效性、先进性。 ⑷提供客户互评及客户给商品评论功能,收集用户对商品的意见及看法。 ⑸提供后台管理页面,简化了用户信息、商品信息、订单信息等系统数据的维护操作。 2.2运行环境

软件概要设计说明书

xxx项目概要设计说明书 (xxx模块) 拟制日期yyyy-mm-dd 评审人日期 批准日期 签发日期

文档修订记录

目录 1. 简介错误!未定义书签。 . 编写目的...................................................... 错误!未定义书签。 . 适用范围...................................................... 错误!未定义书签。 软件名称 .................................................. 错误!未定义书签。 软件功能 .................................................. 错误!未定义书签。 软件应用 .................................................. 错误!未定义书签。 . 定义及关键词.................................................. 错误!未定义书签。 . 参考资料...................................................... 错误!未定义书签。 2. 第0层设计描述 ................................................... 错误!未定义书签。 . 软件系统上下文定义............................................ 错误!未定义书签。 . 设计思路(可选) ................................................ 错误!未定义书签。 设计可选方案 .............................................. 错误!未定义书签。 设计约束 .................................................. 错误!未定义书签。 其他 ...................................................... 错误!未定义书签。 . 系统结构...................................................... 错误!未定义书签。 系统结构描述 .............................................. 错误!未定义书签。 XXX模块................................................... 错误!未定义书签。 3. 第一层设计描述 ................................................... 错误!未定义书签。 . 模块的系统结构................................................ 错误!未定义书签。 模块内部结构 .............................................. 错误!未定义书签。 业务流程说明 .............................................. 错误!未定义书签。 . 分解描述...................................................... 错误!未定义书签。 XXX子模块................................................. 错误!未定义书签。 数据设计 .................................................. 错误!未定义书签。 . 依赖性描述.................................................... 错误!未定义书签。

概要设计说明书---案例

<网上书店> 概要设计说明书 作者:XXXXXXXXXXX 完成日期:XXXX年4月XX日签收人:XXXXXX 签收日期:XXXX年X月XX日修改情况记录:

目录 1 引言 (1) 1.1 编写目的 (1) 1.2 范围 (1) 1.3 定义 (1) 1.4 参考资料 (2) 2 总体设计 (2) 2.1 需求规定 (2) 2.2 运行环境 (3) 2.3 基本设计概念和处理流程 (3) 2.4 结构 (4) 2.5 功能需求与程序的关系 (8) 2.6 人工处理过程 (9) 2.7 尚未解决的问题 (9) 3 接口设计 (10) 3.1 用户接口 (10) 3.2 外部接口 (10) 3.3 内部接口 (10) 4 运行设计 (10) 4.1 运行模块组合 (10) 4.2 运行控制 (10) 4.3 运行时间 (11) 5 系统数据结构设计 (11) 5.1 逻辑结构设计要点 (11) 5.2 物理结构设计要点 (11) 6 系统出错处理设计 (12) 6.1 出错信息 (12) 6.2 补救措施 (12) 6.3 系统维护设计 (12) 7 阶段小结 (12)

1 引言 1.1 编写目的 服务于书店的网络化运营,管理用户购买以及其它服务、管理各类图书信息以及图书销售中的各个环节,最终用户为使用本网上书店的各类用户以及网上书店的系统管理人员和维护人员。 1.2 范围 说明: a.待开发的软件系统的名称:XXXX网上书店 b.任务提出者:刘俊铖、马俊 开发者:马俊、张倩、刘俊铖、张瑞鑫、唐志军、冯庆丰 用户:欲使自己书店网络化运营的各类书店。 使用本软件的单位:待定 1.3 定义 UML:Unified Modeling Language , 统一建模语言。 类图(class diagram):表述系统中各个对象的类型及其间存在的各种静态关系。静态关系包括关联和子类型两种。 交互图(interactive diagram):是表述各组对象如何依某种行为进行协作的模型。包括顺序图和协作图。 可修改性:容许对系统进行修改而不增加原系统的复杂性。 有效性:软件系统能有效地利用计算机的时间资源与空间资源的能力。 可靠性:能够防止因概念、设计和结构等方面的不完善造成的软件系统 失效,具有挽回因操作不当造成软件系统失效的能力。

相关文档
最新文档