搜档网
当前位置:搜档网 › 概要设计实例

概要设计实例

概要设计实例
概要设计实例

概要设计说明书

1.引言

1.1编写目的

本概要设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行总体设计,在明确系统需求的基础上划分系统的功能模块,进行系统开发的分工,明确各模块间的接口,为进行后面的详细设计和实现作准备。本概要设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣,在以后想对系统进行扩展和维护的人员。

1.2背景

a.待开发的系统的名称:Lyra Resource Platform;

b.本项目的任务提出者: 赵东,成富,陈良,窦文敏

开发者:赵东,成富,陈良,窦文敏

用户:所有对该项目感兴趣,并想通过该项目的产品提高资源检索速度和质量,方便的进行资源检索,预览,上传及下载的用户。

2.总体设计

2.1需求规定

2.1.1系统功能

● FTP的文件上传及下载功能:类似于普通ftp的文件上传和下载功能。

◆用户输入ftp的服务器ip及用户名,密码,连接服务器并上传或下载用

户指定的文件。

◆如果用户不输入用户名,密码则默认为匿名登录。

◆可以以列表的形式显示服务器连接信息,以表格的形式显示正下载文件的

信息。

◆具有站内搜索功能。

●资源实时检索功能:提供一个强大的搜索引擎功能,用户只需提供关键字和需要

检索的资源的类型,就能检索到上面所述四种子平台上的所有相关资源,并且列出

来的资源都是可使用的。

●资源预览功能:对于服务器上的某些资源,用户可以选择预览,以确定是否下载。

●资源统计信息的功能:包括最近更新的资源,网上评论较热门的资源等。提供一个

详细的列表,方便用户浏览。

2.1.2系统性能

2.1.2.1时间特性要求

系统的速度要在用户可接受的范围内,但考虑到需要实时检测服务器的可用性,对资源实时搜索的速度可以有较低的要求。ftp的文件上传和下载速度要尽量的接近于普通ftp的速度。

2.1.2.2可靠性

系统要有较高的可靠性,可恢复性。

2.1.2.3灵活性

系统要有良好的接口,以适应增加资源平台,增加资源类型,增加相关的资源获取功能的需求;并留有服务器接口,适应对以后实现服务器功能的需要;同时系统还需要具有跨平台功能。

2.1.3输入输出要求

于ftp和资源实时检索功能系统的输入数据分为两种类型,如果用户已知服务器ip,用户名,密码,则输入数据为服务器ip,用户名,密码;如果用户只知道需要的资源名称和类型,则输入需要的资源名称和类型。系统输出为用户需要的资源列表。并下载用户选择的文件。

对于预览功能,用户需要选择要预览的文件,系统输出该文件的一部分或全部内容,如果用户选择保存预览内容,则保存。

2.1.4数据管理能力要求

系统需要记录用户最近连接过的ftp的地址,用户名,密码及该站点的文件列表。2.1.5故障处理要求

具有一定的容错能力,能检测用户的错误输入并给出错误提示,能检测资源的可用性错误并输出结果。能进行系统故障恢复。

2.1.6其他专门要求

因为本系统是一个普遍使用的工具,所以要求界面友好,使用方便,并要求系统具有高稳定性,可扩充性和运行环境的可转换性。

2.2运行环境

2.2.1设备

普通pc机,互联网。

2.2.2支持软件

操作系统:windows或linux

其它软件:jdk 1.4

2.2.3接口

该系统早期会使用北大天网FTP搜索引擎和其他的文件搜索系统如百度的功能实现资源的检索,但是在后期时间允许的情况下会开发自己的检索部分。

2.3基本设计概念和处理流程

系统的用况图如下:

图1 系统的用况图

活动者:用户,即使用系统进行资源上传下载,站内搜索,资源实时检索,资源预览和资源统计信息的人。

用况说明:

●用况名称:上传

参与者:用户

主要事件流:

1. 用户输入ftp的ip及用户名,密码。

2. 系统连接ftp。

3. 用户选择资源并选择上传功能。

4. 系统运行上传功能,并显示资源上传信息。

异常事件流:

1. 用户输入的ftp无法连接。

2. 显示ftp无法连接,并提示原因,如无法找到此ftp,用户名或密码错误,ftp连接人数已满等等。

异常事件流:

1. 资源上传出错。

2. 显示资源上传错误,并提示原因,如无上传权限,ftp空间已满等等。

●用况名称:下载

参与者:用户

主要事件流:

1. 用户输入ftp的ip及用户名,密码。

2. 系统连接ftp。

3. 用户选择资源并选择下载功能。

4. 系统运行下载功能,并显示资源下载信息。

异常事件流:

1. 用户输入的ftp无法连接。

2. 显示ftp无法连接,并提示原因,如无法找到此ftp,用户名或密码错误,ftp连接人数已满等等。

异常事件流:

1. 资源下载出错。

2. 显示资源下载错误,并提示原因,如无下载权限,用户磁盘空间已满等等。

●用况名称:站内搜索

参与者:用户

主要事件流:

1. 用户输入需要搜索的资源名称关键字。

2. 系统进行站内搜索并显示搜索结果。

●用况名称:资源实时搜索

参与者:用户

主要事件流:

1. 用户输入需要搜索的资源名称关键字,选择需要的资源类型。

2. 系统进行实时检索。

3. 输出检索结果。

4. 用户在检索结果中选择需要的资源。

5. 系统连接用户选择的资源,并显示。

异常事件流:

1. 实时检索出错。

2. 显示错误。

●用况名称:预览

参与者:用户

主要事件流:

1.用户选择需要预览的资源并选择预览功能。

2.系统显示资源的内容。

3.用户选择保存预览资源。

4.系统将该资源保存到用户选择的目录。

异常事件流:

1. 预览出错。

2. 系统显示出错信息。

●用况名称:统计资源信息

参与者:用户

主要事件流:

1. 用户输入需要统计信息的资源类型。

2. 系统统计资源的信息。

3. 显示资源的统计信息。

异常事件流:

1. 统计资源信息出错。

2. 系统显示出错信息。

系统的主要使用流程:

2.4结构

系统物理结构图:

BT服务器图2 系统物理结构图

系统模块图

图3 系统模块图

●ui:系统界面部分,负责接受用户输入,显示系统输出,负责其他模块功能的协调调用,

并含有站内搜索功能,即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui 部分调用common部分的功能读取xml文件中保存的界面元素属性信息,用户最近访问过的10个ftp信息,用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。

●client:实现ftp客户端的功能,ftp连接,ftp上传及下载:上传或下载用户指定的

资源,并返回相应的信息。

●search:资源实时检索部分,根据用户输入的资源名称关键字,资源类型和选择的检索

方式检索用户需要的资源,并验证资源的可用性,返回可用资源及其大小,速度等相关信息。

●preview:资源预览部分,显示用户选择的资源的部分内容,以使用户决定是否需要该

资源。preview部分调用common部分读取属性文件的内容以设置预览资源内容的显示格式。

2.5功能需求与系统模块的关系

3.接口设计

3.1用户接口

1.用户:用户需要浏览的ftp的ip,用户名,密码。

系统:打开该ftp,根据用户的选择上传,下载或预览资源。

2.用户:用户需要实时检索的资源的名称关键字和资源类型。

系统:实时检索用户需要的资源,显示可用资源的列表。

3.用户:输入需要统计信息的资源类型

系统:统计资源信息并显示。

3.2外部接口

调用天网的文件检索功能:参数:需要检索的资源名称关键字,

返回:与该关键字匹配的所有资源的url。

调用百度的搜索功能:参数:需要检索的资源名称关键字,

返回:与该关键字匹配的所有资源的url。

3.3内部接口

[说明本系统之内的各个系统元素之间的接口的安排。]

ui与client间的接口:

输入:ftp地址,用户名,密码,需上传的资源,上传到的目录。

输出:上传速度,其它相关信息。

输入:ftp地址,用户名,密码,需下载的资源,下载的目录。

输出:下载速度,其它相关信息。

ui内部界面与资源站内搜索间的接口:

输入:ftp地址,需搜索资源的名称关键字。

输出:搜索结果列表。

ui与search间的接口:

输入:需搜索资源的名称关键字,需搜索资源的种类。

输出:搜索结果列表。

ui与preview间的接口:

输入:需预览资源的地址及类型。

输出:需预览资源的内容。

ui与统计资源信息界的接口:

输入:需统计信息的资源类型。

输出:资源统计信息。

4.运行设计

4.1运行模块组合

ftp上传功能:系统界面模块,ftp上传模块。

ftp下载功能:系统界面模块,ftp下载模块。

资源站内搜索功能:系统界面模块,站内搜索模块。

资源实时检索功能:系统界面模块,资源实施检索模块。

资源预览功能:系统界面模块,预览模块。

统计资源信息功能:系统界面模块,统计资源信息模块。

4.2运行控制

ftp上传:输入ftp的ip,用户名,密码。

连接ftp,显示ftp的内容。

浏览ftp选择要上传到的目录。

选择需要上传的资源并选择上传功能。

执行上传操作。

显示上传速度及相关信息。

ftp下载:输入ftp的ip,用户名,密码。

连接ftp,显示ftp的内容。

浏览ftp选择要下载资源所在的目录。

选择需要下载的资源并选择下载功能。

执行下载操作。

显示下载速度及相关信息。

资源站内搜索:输入需要搜索的资源名称关键字。

搜索用户指定的资源。

返回搜索结果。

资源实时搜索:输入需要搜索的资源名称关键字及资源类型。

进行资源实时搜索。

显示可用资源列表。

执行其他所需的操作如下载。

资源预览:选择需要预览的资源并选择预览功能。

显示资源的部分内容。

决定是否保存该资源。

统计资源信息:输入需统计信息的资源类型。

执行统计资源信息功能。

显示结果。

5.系统数据结构设计

5.1逻辑结构设计要点

主要的逻辑结构如下:

serversinfor:ftp服务器信息。

属性:name(服务器名称或url)

port(端口号)

username(用户名)

password(密码)。

NetResource:实时检索到的资源。

属性:fileURL(文件资源的URL,包括协议、主机字符串、路径、文件名)fileDate(天网将它编入索引的日期)

fileSize(文件的大小)

responseTime(以毫秒计算的响应时间)。

5.2物理结构设计要点

用户最近访问的ftp服务器信息使用xml文件保存。

用户最近访问的ftp服务器的内容使用xml文件保存,每个ftp的内容存为一个xml 文件。

系统中对资源分类的类型使用xml文件保存。

系统界面的显示属性,如字体属性等使用xml文件保存。

系统界面中使用的相关图片需要保存在客户端机器上。

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

《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 处理流程 下面将使用(结构化设计)面向数据流的方法对机票预定系统的处理流程进行分

××-软件项目概要设计说明书(模板)

××_软件项目概要设计说明书 版本: 编制: 审核: 批准: 日182017颁布日期:年4月□非受控受控状态:■受控 分发范围:项目组、财务部、质量管理部I 版软件项目概要设计说明书××_ 本:V0.1 修订记录 修订日版本修订描修订批准

版××_软件项目概要设计说明书本:V0.1 目录 1 引言.............................................................................................................................................................. . (1) 1.1 概述 (1) 1.2 目的 (1) 1.3 范围 (1) 1.4 缩略语 (1) 1.5 术语.................................................................................................................... 错误!未定义书签。 2 参考资料 (2) 3 交付需求列表 (2) 4 系统物理架构 (2) 4.1 系统运行的硬件环境 (2) 4.2 系统运行的软件环境 (3) 4.3 系统运行的网络环境 (3) 4.4 系统部署图 (3) 4.5 安装部署说明 (4) 5 系统逻辑架构 (5)

5.1 子系统 一 (5) 子模块一...................................................................................................................................... 51.1.1子模块二...................................................................................................................................... 51.1.2 5.2 子系统 二 (5) 6 实现视图 (5) 7 进程视图 (6) 8 数据库设计 (6) 9 设计约束 (6) 10 内部接口定义 (6) 11 外部接口 (6) 12 开发环境说明 (7) 13 技术难点 (7) 14 附录.............................................................................................................................................................. .. 8 14.1 模型文件 (8) 14.2 XXXX (8) III _××软件项目概要设计说明书版本:V0.1 ××_软件项目概要设计说明书 1引言 1.1概述 应包括:{ 项目的委托单位、开发单位和主管部门; a. 该软件系统与其他系统的关系。} b.

概要设计说明书实例

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)

产品概要设计说明

产品概要设计说明书 类似于京东商城,基于BTB\BTC,买卖方都有ERP后台管理系统,有支付端口,物流管理系统、手机移动系统。 1. 引言 1) 编写目的 该概要设计书从整体上把握平台功能设计,包括产品功能、模块划分、处理流程,详细描述用户需求与应用系统之间的关系,在产品设计和研发过程中起到了指导作用。 2) 定义 定义在本文档中出现的重要术语,为读者在阅读本文档时提供必要的参考信息 术语说明 App 运?行在移动智能手机上的软件 安卓App 运行在安卓手机操作系统上的软件,三星、HTC、华为、中兴等出品的智能?手机均为运行安卓手机操作系统的移动终端设备

iPhone App 运行在iPhone 设备上的软件 PC 管理端运行于PC 浏览器上的管理系统,只有甲方管理员可以看到 服务器后台运行在服务器上的后台程序,没有?用户界?面,平台所有的数据都保存在这?里,为PC 管理端、安卓APP、iPhone App 的运?行提供?支撑 人月软件工程上的?个用户计算?工作量的单位,1?月表示单个人?个月,如一项内容1.5?月完成,则表示该内容需要1个人1.5个月完成 2. 范围 1) 系统目标 构建市场的垂直交易平台,提供云库ERP,降低供应商、采购商的管理成本。 2) 主要需求 ?商品交易平台 ?移动端和PC 端的信息统一平台 ?线上、线下相结合的产品展?示和管理 ?已云库概念建设ERP、管理、物流管理

?包含交易现?金的产品展?示和管理 3. 系统结构设计 4. 功能结构设计 系统按照用户群体分为供货商、采购方、物流方、管理中心。 1) 供货商 供货商为商品、相关服务的提供者,系统主要为其提供云库ERP(下称 ERP)。 账户管理 ?供货商提交相关资质资料可以注册ERP,平台审核通过后即可开通供货商的 ERP 系统 ?供货商可以在个人设置?里设置企业的相关信息,包括位置、联系电话、登录密码等 商品管理 ?供货商登录系统后,可以查看、更改已有商品 ?供货商登录系统后,可以增加新商品,包括商品的价格、规格、参数等商品相 关信息

软件概要设计说明书范例

XX概要设计说明书

文档修改记录

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

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

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

《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 处理流程 下面将使用(结构化设计)面向数据流的方法对机票预定系统的处理流程进行分析。系统可分为两大部分:一、客户机上的程序,二、服务器上的程序。以下将分别对系统的这两大部分进行流程分析:

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

ISO软件工程模板概要设计说明书 摘要 大伙儿在平常的系统开发中需要编写一些文档模板,这此将我收集整理的ISO软件工程模板标准贴出,供大伙儿参考。(2002-07-22 18:06:09) By 风过留枫 1.引言 1.1编写目的 [说明编写这份概要设计说明书的目的,指出预期的读者。] 1.2背景 a.[待开发软件系统的名称;] b.[列出本项目的任务提出者、开发者、用户。] 1.3定义 [列出本文件中用到的专门术语的定义和外文首字母组词的原词组。] 1.4参考资料 [列出有关的参考资料。] 2.总体设计 2.1需求规定 [说明对本系统的要紧的输入输出项目、处理的功能性能要求。包括] 2.1.1系统功能 2.1.2系统性能 2.1.2.1精度 2.1.2.2时刻特性要求

2.1.2.4可靠性 2.1.2.5灵活性 2.1.3输入输出要求 2.1.4数据治理能力要求 2.1.5故障处理要求 2.1.6其他专门要求 2.2运行环境 [简要地说明对本系统的运行环境的规定。] 2.2.1设备 [列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能。] 2.2.2支持软件 [列出支持软件,包括要用到的操作系统、编译(或汇编)程序、测试支持软件等。] 1 2.2.3接口 [说明该系统同其他系统之间的接口、数据通信协议等] 2.2.4操纵 [说明操纵该系统的运行的方法和操纵信号,并说明这些操纵信号的来源。] 2.3差不多设计概念和处理流程 [说明本系统的差不多设计概念和处理流程,尽量使用图表的形式。] 2.4结构 [给出系统结构总体框图(包括软件、硬件结构框图),说明本系统的各模块的划分,扼要说明每个系统模块的标识符和功能,分层次地给出各模块之间的操纵与被操纵关系。] 2.5功能需求与系统模块的关系 [本条用一张矩阵图说明各项功能需求的实现同各模块的分配关系。] [系统模块1][系统模块2][……][系统模块m] [功能需求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.功能需求与程序的关系

需求分析说明书、详细设计说明书、概要设计说明书样例

以下是需求分析说明书、详细设计说明书、概要设计说明书样例 需要详细资料的去 https://www.sodocs.net/doc/1a15671306.html,/BBS/view.asp?ID={CA9329C0-93C5-4417-9170-452FF61E8C DB}&page=1下载 XX系统概要设计说明书 目录 1. 文档介绍1 1.1 文档目的1 1.2 文档范围1 1.3 读者对象1 1.4 参考文献1 1.5 术语与缩写解释1 2. 系统概述2 3. 设计约束2 3.1需求约束2 3.2隐含约束2 4. 设计策略3 4.1扩展策略3

4.2复用策略3 4.3折衷策略3 5.系统总体结构3 5.1、系统总体结构3 5.2、子系统功能及接口4 6. 子系统的结构与功能5 6.1、TERMSERV 5 7. 功能需求追溯5 8. 环境的配置5 9.其它6 附录 6 A、与主机接口6 B、与终端接口6 1. 文档介绍 1.1 文档目的 编写该文档的目的在于从总体设计的角度明确xxxx系统的功能和处理模式,明确与银联的接口,使系

统开发人员和产品管理人员明确产品功能,可以有针对性的进行系统开发、测试、验收等各方面的工作。 1.2 文档范围 1.3 读者对象 该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。 1.4 参考文献 《xxxx系统需求说明书》 1.5 术语与缩写解释 无 2. 系统概述 XX系统是以触摸屏为主要交互工具,帮助用户以自助方式做业务查询。本系统的主要功能包括:话费 查询、新业务介绍、网点分布查询、自助终端分布查询、电信新闻、交易监控、设备维护和监控等。本系 统的设计目标是保证系统可以7*24小时安全、高效无故障运行;业务人员可以轻松完成设备和交易的监控 、管理工作;报表种类齐全,可以满足业务人员各种帐务需求。 3. 设计约束

软件概要设计说明书模版

软件概要设计报告文档模板 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 参考资料 列举编写软件产品概要设计报告时所用到的参考文献及资料,可能包括: ●本项目的合同书; ●上级机关有关本项目的批文; ●本项目已经批准的计划任务书; ●用户界面风格指导;

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

<网上书店> 概要设计说明书 作者: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):是表述各组对象如何依某种行为进行协作的模型。包括顺序图和协作图。 可修改性:容许对系统进行修改而不增加原系统的复杂性。 有效性:软件系统能有效地利用计算机的时间资源与空间资源的能力。 可靠性:能够防止因概念、设计和结构等方面的不完善造成的软件系统 失效,具有挽回因操作不当造成软件系统失效的能力。

需求分析说明书、概要设计说明书、详细设计说明书部分样例.doc

需求分析说明书、概要设计说明书、详细设计说明书部分样例 作者:rjgczj 出处:csai论坛 以下是需求分析说明书、详细设计说明书、概要设计说明书样例,需要的朋友来信联系。rjgczj@ For personal use only in study and research; not for commercial use XX系统概要设计说明书 目录 1. 文档介绍1 1.1 文档目的1 1.2 文档范围1 1.3 读者对象1 1.4 参考文献1 1.5 术语与缩写解释1 2. 系统概述2 3. 设计约束2 3.1需求约束2 3.2隐含约束2 4. 设计策略3 4.1扩展策略3 4.2复用策略3 4.3折衷策略3 5.系统总体结构3 5.1、系统总体结构3

5.2、子系统功能及接口4 6. 子系统的结构与功能5 6.1、TERMSERV 5 7. 功能需求追溯5 8. 环境的配置5 9.其它6 附录 6 A、与主机接口6 B、与终端接口6 1. 文档介绍 1.1 文档目的 编写该文档的目的在于从总体设计的角度明确xxxx系统的功能和处理模式,明确与银联的接口,使系统开发人员和产品管理人员明确产品功能,可以有针对性的进行系统开发、测试、验收等各方面的工作。 1.2 文档范围 1.3 读者对象 该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。 1.4 参考文献 《xxxx系统需求说明书》 1.5 术语与缩写解释 无 2. 系统概述 XX系统是以触摸屏为主要交互工具,帮助用户以自助方式做业务查询。本系统的主要功能包括:话费查询、新业务介绍、网点分布查询、自助终端分布查询、电信新闻、交易监控、设备维护和监控等。本系统的设计目标是保证系统可以7*24小时安全、高效无故障运行;业务人员可以轻松完成设备和交易的监控、管理工作;报表种类齐全,可以满足业务人员各种帐务需求。

概要设计说明文档

概要设计说明文档

《智慧后勤支撑平台》概要设计说明书 1 引言 1.1 编写目的 本设计书是高校固定资产管理项目程序的研发概要设计,将项目开发进程中或者项目结束后提供给双方人员使用,同时也可以作为实施后期的维护人员使用。 1.2 项目背景 作为软件开发的前期文档,可以帮助程序设计人员和管理人员提供清晰的设计思路,在软件开发后期的维护阶段也起到至关重要的作用。 委托单位:上海明略企业管理咨询有限公司 开发单位:上海明略企业管理咨询有限公司负责人:白老师 随着我国世界影响力的提升,国内承办的世界级重要活动越来越多,而稳定、高效的电力保障是重要活动顺利举办的基础。保电后勤工作作为电力保障的支撑部门,在重要活动保电行动中承载着重要的使命。为此,作为世界互联网大会·乌镇峰会的电力保障责任单位嘉兴供电公司,以往届保电后勤保障经验为基础、先进的后勤知识为指引,提出利用互联网技术,为重要活动保电提供全方位、及时的后勤保障,搭建后勤支撑平台,提升保电后勤管理效率,优化后勤专业水平,实现保电后勤保障的智慧化支撑,从而为重要活动保电的顺利进行提供保障。 1.3 定义 B/S :(Browser/Server结构)结构即浏览器和服务器结构。 需求:用户解决问题或达到目标所需的条件和功能;系统或系统部要满足合同、标准,规范或其他正式文档所需具有的条件及权能。 1.4 参考资料 《国家标准软件开发文档规范》《软件开发流程》 2 任务概述 2.1 目标 智慧后勤支撑平台主要功能有:资源信息管理与移动端查看,相关手册的维护,报表数据的查看与统计,广告管理,消息管理,权限设置,系统日志等功能。 2.2 运行环境 ·主机: PC兼容机内存8GB以上,显示分辨率1336*768以上

概要设计的写法

概要设计的写法 做软件到一定层次了,就要考虑到设计了,设计了很久,就是不系统,系统的设计需要一个记录,记录就用文档,那么对项目所有包括技术上的设计都记录下来,我们就可以理解为软件的概要设计了。在需求明确、准备开始编码之前,要做概要设计,而详细设计可能大部分公司没有做,有做的也大部分是和编码同步进行,或者在编码之后。因此,对大部分的公司来说,概要设计文档是唯一的设计文档,对后面的开发、测试、实施、维护工作起到关键性的影响。 概要设计写什么?概要设计怎么做?如何判断设计的模块是完 整的?为什么说设计阶段过于重视业务流程是个误区?以需 求分析文档还是以概要设计文档来评估开发工作量、指导开发计划 准确?结构化好还是面向对象好?以上问题的答案请在文章 中找。 二、概要设计的目的? 将软件系统需求转换为未来系统的设计;逐步开发强壮的系统构 架;使设计适合于实施环境,为提高性能而进行设计;结构 应该被分解为模块和库。 三、概要设计的任务? 制定规范:代码体系、接口规约、命名规则。这是项目小组今后共 同作战的基础,有了开发规范和程序模块之间和项目成员彼此之间 的接口规则、方式方法,大家就有了共同的工作语言、共同的工作 平台,使整个软件开发工作可以协调有序地进行。总体结构设 计:功能(加工)->模块:每个功能用那些模块实现,保证每 个功能都有相应的模块来实现;模块层次结构:某个角度的软件 框架视图;模块间的调用关系:模块间的接口的总体描述;模 块间的接口:传递的信息及其结构;处理方式设计:满足功能 和性能的算法用户界面设计;数据结构设计:详细的数 据结构:表、索引、文件;算法相关逻辑数据结构及其操作;上 述操作的程序模块说明(在前台?在后台?用视图?用过程?······)接口控制表的数据结构和使用规则其他性能设计。 四、概要设计写什么?

(需求分析+概要设计+详细设计)文档简单范例

软件开发文档 项目名: “通讯录” 版本: α测试版 作者: ccba 编写时间:2001-8-20 文档内容: 1 需求规格说明书 2 概要设计说明书 3 详细设计说明书 文档号IM00101 需求规格说明书 1、引言: 1.1 编写目的 本文档的编写是为了确定待开发软件的功能、性能、数据、界面的需求。 1.2 项目背景 “通讯录”软件是为了提供一种功能完备,易于操作、界面美观的优秀软件。该软件由蔡文亮单独开发完成。 1.3 定义 需求规格说明书采用参考资料②标准 1.4 参考资料 ①薛华成《管理信息系统(第三版)》清华大学出版社1999.5 ②郑人杰、殷人昆、陶永雷《实用软件工程(第二版)》清华大学出版社1997.4 ③周之英《现代软件工程(基本方法篇)》科学出版社 2000.1 2、功能需求 该软件由四个主功能模块和一个扩展功能模块构成,各功能模块中规定的均为软件的基本功能,在开发过程中,开发人员可根据实际情况在满足基本功能需求的前提下增加新功能,但必须详细编写相关文档。 2.1录入、修改功能模块 该功能块主要用于数据库的数据录入和修改,考虑到通讯录的实际需要,可以放松对数据库完整性结束的控制,但从减少数据库的角度来考

虑,不容许有完全相同的纪录出现(考虑的合并,相同的纪录项)。 2.2查询功能块 本功能模块是最重要的功能块,对通讯录的操作最主要部分就是查询操作。 本功能块要求有如下功能: 1)按数据库各个属性查询 2)按数据库各个属性之间的逻辑组合查询 如:查询名称为“鸭子”且年龄为20岁的详细情况 (SQL语句表示)SELECT * FROM MESSAGER WHERE NICKNAME=“鸭子” AND AGE=20 3)按某一属性的数值范围查询及其逻辑组 如:查询年龄在20至35岁间的详细情况 (SQL语句表示)SELECT * FROM MESSAGER WHERE AGE BETWEEN 20 AND 35 4)模糊查询 同时我们要求查询结果可以按用户要求的格式来显示,如:用户能调整显示属性的个数和组合。 2.3系统安全块 通讯录的信息是个人隐私,故在软件中加入必要的安全措施。主要有以下三点: 1)登录帐号和密码的管理 2)帐户权限的控制 3)对部分登录帐号隐藏部分内容 2.4系统设置块 本部分内容主要是对软件使用时一些设置使其更利于软件的使用:主要包括以下四个方面: 1)系统界面背景和色彩设置(模仿WINNAP) 2)闹铃功能开关,即实现朋友生日提醒功能 3)记录内容项(即数据库修改通讯录上的内容项) 4)历史记录,用户可以选择是否记录下何人何时使用过该软件 2.5扩展功能块 1)网络功能:通过OLE/COM接口的调用,实现E-mail软件调用。2)帮助文档的制作(On-line help)

概要设计报告文档模板

概要设计报告模板 目录 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 系统结构设计 (5) 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 参考资料 列举编写软件产品概要设计报告时所用到的参考文献及资料,可能包括: ●本项目的合同书; ●上级机关有关本项目的批文;

相关主题