软件工程模板概要设计说明书

时间:2024.3.31

 


 


变更记录

签字确认


 

1     引言......................................................................................................................... 5

1.1      编写目的............................................................................................................ 5

1.2      背景................................................................................................................... 5

1.3      基线................................................................................................................... 5

1.4      范围................................................................................................................... 5

1.5      定义................................................................................................................... 5

1.6      参考资料............................................................................................................ 5

2     总体设计.................................................................................................................. 5

2.1      概述................................................................................................................... 5

2.1.1       功能描述..................................................................................................... 5

2.1.2       运行环境..................................................................................................... 6

2.1.3       开发环境..................................................................................................... 6

2.2      设计思想............................................................................................................ 7

2.2.1       系统构思..................................................................................................... 7

2.2.2       关键技术与算法.......................................................................................... 8

2.2.3       关键数据结构.............................................................................................. 9

2.3      人工处理过程..................................................................................................... 9

3     系统功能设计.......................................................................................................... 9

3.1      个人办公............................................................................................................ 9

3.1.1       日程安排..................................................................................................... 9

4     系统数据结构设计................................................................................................. 14

4.1      说明................................................................................................................. 14

4.2      数据结构.......................................................................................................... 14

4.3      数据结构与系统元素的关系.............................................................................. 14

5     接口设计................................................................................................................ 14

5.1      用户接口.......................................................................................................... 14

5.2      外部接口.......................................................................................................... 14

6     运行设计................................................................................................................ 15

6.1      系统初始化...................................................................................................... 15

6.2      运行控制.......................................................................................................... 15

6.3      系统结束.......................................................................................................... 15

7     系统出错处理设计................................................................................................. 15

7.1      出错信息.......................................................................................................... 15

7.2      补救措施.......................................................................................................... 15

8     系统维护设计........................................................................................................ 16

8.1      检测点的设计................................................................................................... 16

8.2      检测专用模块的设计........................................................................................ 16

9     尚待解决的问题..................................................................................................... 16


1       引言

1.1   编写目的

l  本说明书目的在于明确说明系统各功能的实现方式,指导开发员进行编码。

l  本说明书的预期读者为:XXX等。

1.2   背景

待开发软件系统的名称:XXX

此软件系统任务提出者:XXX

此软件系统任务开发者:XXX

此软件系统任务用户:XXX

1.3   基线

XXX需求分析说明书 v1.0

1.4   范围

XXX。

1.5   定义

XXX:YYY。

1.6   参考资料

属于本项目的其他已发表的文件。

本文件中引用的其他文献、资料以及软件开发标准。

2       总体设计

2.1   概述

2.1.1        功能描述

系统包括的范围:XXX。

2.1.2        运行环境

2.1.2.1  软件环境

2.1.2.2  硬件环境

2.1.3        开发环境

2.1.3.1  服务器软件环境

2.1.3.2  服务器硬件环境

2.1.3.3  开发机器软件环境

2.1.3.4  开发机器硬件环境

2.2   设计思想

2.2.1        系统构思

系统功能层次图

2.2.2        关键技术与算法

2.2.2.1     XXX

简要说明本系统中的主要技术与算法。这部分是概要设计的核心!!!

2.2.3        关键数据结构

2.2.3.1     XXX

简要说明本系统中的最主要的数据结构。

2.3   人工处理过程

说明在本系统的运行过程中不得不包含的人工处理过程(若有的话)。指出该处理过程在系统中的前后相关的功能及操作。该过程出现的原因,输入、输出、处理过程。

3       系统功能设计

此部分主要对关键功能进行设计,描述其实现方式。

如果对详细设计要求不高,也可在下面的部分中包括对详细设计的功能说明,不必另建详细设计文件。此部分主要对各模块功能进行分解,尽量能细化到每一个操作。同时附以特征界面和数据表设计。

3.1   XX功能

在本系统中为员工日常办公常用功能,包括个人信息维护、日程安排、名片夹、通讯录,并且能够查看个人的待办工作、已办工作、催办工作。当个人忘记密码时,由其通过电话向系统管理员询问密码。

3.1.1   XXX子功能

4       系统数据结构设计

4.1   说明

在面向对象的设计方法中,数据也可以作为一个对象来处理,如果数据附属于某一对象,可以将其纳入该对象的属性管理之中。所以在面向对象的设计过程中,对数据的设计是在对对象的设计过程中完成的。

4.2   数据结构

列出本系统使用的主要数据结构,包括它们的名称、标识符及数据项等。

4.3   数据结构与系统元素的关系

说明各个数据结构与访问这些数据结构的各个系统元素之间的对应关系。将数据和系统的程序模块有机地结合起来。可以进一步向系统最终的数学模型(程序语言)靠近。

5       接口设计

5.1   用户接口

说明将向用户提供的接口,以及系统的回答信息。即用户在系统运行过程中提供的输入操作,及系统相应的输出信息。输入操作包括是否通过界面、通过读取数据文件等方式实现。

5.2   外部接口

说明本系统同外界的所有接口,包括与硬件、各支持软件之间的接口关系。指出输入、输出方,接口数据的特点等。

6       运行设计

6.1   系统初始化

说明本系统的初始化过程。以流程的方式描述系统依次的动作,包括内存使用情况、数据初始化、对象的初始化等。

6.2   运行控制

a. 说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运行所历经的内部模块和支持软件。

b. 说明每一种外界运行控制的方式方法和操作步骤。

c. 说明每种运行模块组合将占用各种资源的情况。

d. 说明系统运行时的安全控制。

6.3   系统结束

说明本系统的结束过程。以流程的方式描述系统退出时依次的动作,包括内存释放情况、对象的释放等。

一般情况下系统出错设计和系统维护设计不应简化,但对特定情况下(如用户需求中未明确规定或项目周期较短、经费较少、项目复杂程度较少等)这两部分的设计可以简化。

7       系统出错处理设计

7.1   出错信息

包括出错信息表、故障处理技术等。

7.2   补救措施

说明故障出现后可能采取的变通措施,包括:

a.     后备技术  当原始系统数据万一丢失时启用的副本的建立和启动的技术。

b.    降效技术  使用另一个效率稍低的方法来求得所需结果的某些部分,如手工操作和数据的人工记录。

c.     恢复和再启动技术  使系统从故障点恢复执行或使系统从头开始重新运行的方法。

8       系统维护设计

说明为了系统维护的方便,在程序内部设计中作出的安排。

8.1   检测点的设计

说明在程序中专门安排用于系统检查与维护的检测点。

8.2   检测专用模块的设计

说明在程序中专门安排用于系统检查与维护的专用模块。

9       尚待解决的问题

说明在本设计中没有解决而系统完成之前应该解决的问题。


第二篇:软件工程 概要设计说明书


文档编号:001

版本号:1.0

概要设计说明书

                                      

1.引言

1.1 编写目的

在本学生智能管理系统项目的前一阶段,也就是需求分析阶段中,已经将系统用户对本系统的需求做了详细的阐述,这些用户需求已经在上一阶段中对学生的实地调研中获得,并在需求分析中得到了详细的阐明。

本阶段已在系统的需求分析研究的基础上,对学生智能管理系统做概要设计。该阶段正式进入了实际开发阶段,它的目的就是进一步细化软件设计阶段得出的软件总体概貌,把它加工成在程序细节上非常接近于源程序的软件表示。概要设计说明书主要解决了实现本系统需求的程序模块设计问题。包括如何把本系统划分成若干个模块,决定各个模块之间的接口,模块之间传递的信息,以及数据结构,模块结构的设计等。在以下的概要设计报告中将对在本阶段中对系统所做的所有的概要设计进行详细的说明。

在下一阶段的详细设计中,程序设计员可参考此概要设计报告,在概要设计中对学生智能管理系统所做的模块设计的基础上,对系统进行详细设计。在以后的软件测试以及软件维护阶级也可参考此说明书,以便于了解在概要设计过程中所完成的各模块设计结构,或在修改时找出在本阶段设计中的不足或错误。

1.2 项目背景

本项目(学生智能管理系统)由西安邮电学院委托,由<科技1班软件开发小组>负责开发。

本系统与其他系统的关系如下:

1.3 定义

  1.3.1 专门术语

  SQL SERVER: 系统服务器所使用的数据库系统(DBMS)。

  SQL: 一种用于访问查询数据库的语言。

   总体设计:即对有关系统全局问题的设计,也就是设计系统总的处理方案,又称系统概要设计, 是根据逻辑设计对系统进行具体的物理设计。

   接口设计:即对连接软件内各部分或者软件与外部之间交换数据、信息的通道的设计。

   数据结构设计:方法是一种面向数据流的设计方法,它可以与结构化分析方法衔接。结构化设计方法采用结构图来描述系统的模块结构。

   运行设计:包括运行模块的组合和运行控制。

   出错设计:设计可能出现的问题及补救措施。

1.3.2 缩写

   系统: 若未特别指出,均指本学生智能管理系统。

   SQL: Structured Query Language(结构化查询语言)。

1.4参考资料

   以下为在此概要设计中用到的相关资料:

   1.可行性分析                                 软件开发小组    2009/09/11

   2.需求分析                                   软件开发小组    2004/09/30

3.软件工程导论          张海藩           清华大学出版社       2008/01

1.5 约束与限制

1.一个用户在系统中只有一个账号。

2.用户要想查询必须先登陆。

3. 管理员只能进行三次登录。

2.任务概述 

2.1 目标

因大量用户需要异地访问数据,所以使用c/s体系来设计本系统。

用户输入用户名密码后登录到本系统。

管理员看到管理界面。管理员有五大功能:

1. 验证用户注册信息。

2. 修改用户信息。

3. 分配用户权限。

4. 创建删除数据库。

5. 导入外部文本数据。

若用户是普通用户,则有基本功能:账户信息修改。若该用户对一个以上数据库具有访问权限,则可以选择要访问的数据库。其次选择该数据库中所要操作的用户表。然后有两个选择:一是新建报表,二是使用现有模版生成报表。选择新建报表,则进入新建报表向导,提示用户当前表有哪些字段,供用户选择。帮助用户创建自定义列,获取计算表达式。获取需要分类统计的字段。最后产生并呈现报表。如果选择使用现有模版生成报表,则直接产生并呈现报表。得到报表后有两种方式保存。一是保存当前报表为Excel文件到本地端,二是保存报表模版在服务器端。

2.2 运行环境

硬件环境:服务器:PII266  64M  2G以上 。

客户机:PII133  16M 。

网络带宽:10M以上。

软件环境:服务器端:NT4.0以上,IIS4.0以上。
              客户端:WINDOWS9X,IE4.0以上,采用WIN98/2000/XP。

2.3 需求概述

  为了用户能更方便的查询和管理员能更方便的管理,用户只需输入识别信息,如学生学号和姓名,就能进行查询;教师证件号和姓名就能进行信息的存储以及信息的添加、删除、修改。要求系统能有效,快速,安全,可靠和无误的完成上述操作。并要求客户机的界面说明,易于操作,服务器程序利于维护。


3.总体设计

3.1功能分配

   本系统主要完成学生信息的管理,其中主要功能有:系统查询,学生信息管理,教师信息管理,系统管理,基本资料.服务器程序需与已建立的SQL Server数据库互连。

3.2功能说明:

1.总控界面:

系统的开机界面,放置各个功能按钮,可以进入系统。

2.用户注册和注销

登记所有的新学生学号、教师证件号和注销学生学号、教师证件号。

3.查询

(1) 查询学生信息

学生学号、姓名、年级、班级、成绩等信息查询。

(2) 查询教师信息

教师证件号、姓名、代课信息等。

4.统计

(1)学生统计

统计在校学生数、参加活动的学生数、选某课的学生数。

(2)成绩统计

统计学生每学期不同性质课程的成绩。

(3)教师统计

统计在校教师数、教某课程的教师数。

3.3 总体结构和模块外部设计

  本系统主要完成的功能模块有:用户管理,班级管理,课程的管理,学籍的管理和成绩的管理5个部分。

   用户管理:该模块主要是系统管理员对用户信息进行的添加、删除、查询功能。用户可通过它更改自身密码。

   班级管理:添加、删除、修改和查询班级信息。

   课程管理:添加、删除、修改和查询课程信息。

   学籍管理:添加、删除、修改和查询学生信息,并可制作学籍报表。

   成绩管理:添加、删除、修改和查询成绩信息,并可制作成绩报表。

对以上功能进行集中、分块、结构化,得到如下图所示的系统总体功能模块图。

4.接口设计

4.1 外部接口

4.1.1 用户界面

在用户界面部分,根据需求分析的结果,用户需要一个友善界面.在界面设计上,应做到简单明了,易于操作,并且要注意到界面的布局,应突出显示重要以及出错信息。外观上也要做到合理化,考虑到用户对Windows较为熟悉,应尽量向这一方面靠拢。总的来说,用户界面应做到可靠性,简单性,易学习和使用。

4.1.2 软件接口

服务器程序可使用Visual  Basic提供的对SQL Server的接口,进行对数据库的所有访问。在网络软件接口方面,使用一种无差错的传输协议,采用滑动窗口方式对数据库进行网络传输及接收。

4.1.3 硬件接口

在输入方面,对于键盘,鼠标的输入,可用Visual  Basic的标准输入/输出,对输入进行处理。

在输出方面,打印机的连接及使用,也可用Visual  Basic的标准输入/输出对其进行处理。

4.2 内部接口

   内部接口方面,各模块之间采用,参数传递,返回值的方式进行信息传递。具体参数的结构将在下面数据结构设计的内容中说明。接口传递的信息将是以数据结构封装了的数据,以参数传递或返回值的形式在各模块间传输。

5.数据库数据结构设计

5.1 数据库逻辑结构设计

学生信息

              

                1.学生学号             CHAR

                2.学生姓名             CHAR

                3.学生性别             CHAR

                4.个人电话             CHAR  

                5.家庭电话             CHAR

                6.籍贯                 CHAR

                7.系别                 CHAR

             8.年级                 CHAR

                9.班级                 CHAR

                10.备注               CHAR

   教师信息

                 

1. 证件编号                  CHAR

2.姓名                      CHAR

3.性别                      CHAR

4.个人电话                  CHAR

 5.系别                      CHAR

课程信息

                  

    1,课程编号                 CHAR

    2.课程名称                 CHAR

    3.课程类型                 CHAR

    4.课时                     CHAR

    5.学分                     CHAR

    6.任课老师                 CHAR

    7.上课时间                 CHAR

学生课余活动信息

        

       1.活动编号              CHAR

       2.活动名称              CHAR

       3.活动类型              CHAR

       4.活动时间              CHAR

       5.参加院系              CHAR

6.运行设计

6.1 运行模块的组合

   用户有程序输入时,通过各模块的调用,读入并对输入进行格式化,服务器得到数据后返回信息,对信息进行处理后,产生相应的输出。

6.2 运行控制

   运行控制将严格执照各模块间函数调用关系来实现。在各事务中心模块中,需对运行控制进行正确的判断,选择正确的运行控制路径。

6.3 运行时间

在需求分析中,对运行时间的要求为必须对做出的操作有较快的反应。网络硬件对运行的时间有较大的影响,所以将采用高速的ATM网络。其次是服务器的性能,这将影响对数据库的访问时间即操作时间的长短。硬件对本系统的速度的影响将大于软件的影响。

7.出错处理设计

7.1 出错输出信息

   用一览表的方式说明每种可能的出错或故障情况出现时,系统输出信息的形式、含意及处理方法。

7.2 出错处理对策

(1)定期对数据库进行备份,以及安装相应的防火墙,及防病毒程序。定期对服务器进行维护。

(2)当原始系统数据万一丢失时启用的副本的建立和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术。

8.安全保密设计

考虑到不同用户的权限不同,第一次进入该系统时应该向管理员注册一个用户名和密码,并完整的填写相关信息,同时存入数据库表中。这样管理员就可赋予不同用户不同的权限。当用户登录进入操作界面之前,我们设置了用户名和密码,当用户名和密码相匹配时才能进入该用户所允许做的权限操作界面,否则就只能看到登录界面管理员有权力行使所有的管理功能,普通用户只能进行一般的查询。

9.维护设计

  维护方面主要是对数据库进行维护。可使用SQL Server的数据库维护功能机制,要定期的为数据库进行备份,维护管理工作数据库死锁问题和维护数据库内数据的一致性。


更多相关推荐:
软件-设计说明书(范本)

高效率的水稻育种方法控制软件V101高效率的水稻育种方法控制软件V10设计说明书高效率的水稻育种方法控制软件V102一项目背景种植杂交水稻的重要意义就是为了解决世界上人口与粮食不足的问题由于杂交水稻无论是产量抗...

范例-软件设计说明(概要部分)

软件设计说明软件设计说明历史版本记录软件设计说明目录1范围111标识112系统概述113文档概述1234引用文档1CSCI级设计决策1CSCI体系结构设计概要设计141CSCI部件242执行方案343接口设计5...

范例-软件设计说明(详细部分)

软件设计说明软件设计说明软件设计说明目录1范围111标识112系统概述113文档概述1234引用文档1CSCI级设计决策1CSCI体系结构设计241CSCI部件242执行方案343接口设计3431接口标识和接口...

软件设计说明书格式

软件工程数据库课程设计软件设计说明书目录1引言111编写目的112背景说明113定义114参考资料12总体设计321需求规定322运行环境323基本设计概念和处理流程324结构设计3241结构3242功能需求与...

软件设计说明书通用模板

文档编号项目名称DSN版本项目名称软件设计规格说明书日期20xx1208文档变更历史记录2目录目录31引言411编写目的412读者对象413软件项目概述414文档概述415定义416参考资料52软件设计约束62...

软件设计说明书格式

软件工程数据库课程设计软件设计说明书目录1引言311编写目的312背景说明313定义314参考资料32总体设计421需求规定422运行环境423基本设计概念和处理流程424结构设计5241结构5242功能需求与...

详细设计说明书(范例).doc

山东商业职业技术学院SF宠物精灵史努比软件开发文档SF宠物精灵史努比详细设计说明书编写单位设计人员版本编写日期SF软件设计团队10SF宠物精灵史努比软件开发文档目录第一部分引言311编写目的312背景313定义...

毕业设计说明书范例(学生学籍管理系统论文)

DimEditNumAsStringIfListViewSelectedItemSelectedThenEditNumCStrListViewSelectedItemTextCallFrmAddStuLoadS...

软件设计说明书_模板

软件设计说明书RevisionRecord修订记录CopyrightVanceInfoCreativeSoftwareTechnologyLtdPage1Total15第1页共15页

软件设计说明书

软件设计说明书目录1引言22任务概述221需求概述222需求阶段分析阶段的分析模型223系统的目标33概要设计331总体设计3311整体的处理流程3312总体结构设计4313模块功能5314功能分配832接口设...

软件设计说明书

软件工程大作业20xx20xx学年第2学期软件可行性研究报告项目名称实验项目管理系统组员学号0098325姓名陈兴旺专业09计1选课班级B03任课教师狄国强完成时间20xx年月日

02软件设计说明书

7数据结构设计51逻辑结构设计学生考勤表由多个学生考勤记录构成学生考勤记录的数据结构如下学生学号学生姓名院系年级专业性别迟到早退旷课请假整数唯一标识变长字符串变长字符串变长字符串变长字符串变长字符串变长字符串变...

软件设计说明书(29篇)