软件文档中概要设计也称“总体设计”,是开发人员在明确用户需求(要什么)后对系统的一个总体考虑(明确系统目标、设计原则,初步考虑数据库设计和功能设计),国家关于这方面有相关标准(概要设计说明书(GB8567-88))。
在具体实践中可以按下列提纲撰写内容:
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.3可靠性
2.1.2.4灵活性
2.1.3输入输出要求
2.1.4数据管理能力要求
2.1.5故障处理要求
2.1.6其他专门要求
2.2运行环境
[简要地说明对本系统的运行环境的规定。]
2.2.1设备
[列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能。]
2.2.2支持软件
[列出支持软件,包括要用到的操作系统、编译(或汇编)程序、测试支持软件等。]
2.2.3接口
[说明该系统同其他系统之间的接口、数据通信协议等]
2.2.4控制
[说明控制该系统的运行的方法和控制信号,并说明这些控制信号的来源。]
2.3基本设计概念和处理流程
[说明本系统的基本设计概念和处理流程,尽量使用图表的形式。]
2.4结构
[给出系统结构总体框图(包括软件、硬件结构框图),说明本系统的各模块的划分,扼要说明每个系统模块的标识符和功能,分层次地给出各模块之间的控制与被控制关系。]
2.5功能需求与系统模块的关系
[本条用一张矩阵图说明各项功能需求的实现同各模块的分配关系。]
2.6人工处理过程
[说明在本系统的工作过程中不得不包含的人工处理过程。]
2.7尚未解决的问题
[说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。]
3.接口设计
3.1用户接口
[说明将向用户提供的命令和它们的语法结构,以及相应的回答信息。]
[说明提供给用户操作的硬件控制面板的定义。]
3.2外部接口
[说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持系统之间的接口关系。]
3.3内部接口
[说明本系统之内的各个系统元素之间的接口的安排。]
4.运行设计
4.1运行模块组合
[说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运行所历经的内部模块的支持软件。]
4.2运行控制
[说明每一种外界的运行控制的方式方法和操作步骤。]
4.3运行时间
[说明每种运行模块组合将占用各种资源的时间。]
5.系统数据结构设计
[不涉及软件设计可不包含]
5.1逻辑结构设计要点
[给出本系统内软件所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。]
5.2物理结构设计要点
[给出本系统内软件所使用的每个数据结构中的每个数据项的存储要求,访问方法、存取单位、存取的物理关系、设计考虑和保密条件。]
5.3数据结构与程序的关系
[说明各个数据结构与访问这些数据结构的各个程序之间的对应关系。]
6.系统出错处理设计
6.1出错信息
[用一览表的方式说明每种可能的出错或故障情况出现时,系统输出信息的形式、含意及处理方法。]
6.2补救措施
[说明故障出现后可能采取的变通措施。]
6.3系统维护设计
[说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。]
软件概要设计说明书怎么写
通用的软件概要设计说明书国家有标准。例如概要设计说明书(GB8567-88)包括如下内容:
1引言
1.1编写目的
1.2背景
1.3定义
1.4参考资料
2总体设计
2.1需求规定
2.2运行环境
2.3基本设计概念和处理流程
2.4结构
2.5功能器求与程序的关系
2.6人工处理过程
2.7尚未问决的问题
3接口设计
3.1用户接口
3.2外部接口
3.3内部接口
4运行设计
4.1运行模块组合
4.2运行控制
4.3运行时间
5系统数据结构设计
5.1逻辑结构设计要点
5.2物理结构设计要点
5.3数据结构与程序的关系
6系统出错处理设计
6.1出错信息
6.2补救措施
6.3系统维护设计
根据具体项目内容可以有所微调。
软件概要设计文档应该具有什么内容
一、概论1、编写目的2、编写背景3、对系统的大致描述二、业务概述和逻辑设计1、对系统几大主体的描述2、对系统几大业务流程描述3、用UML对其进行总体描述三、技术架构在此章决定使用那种技术体系,具体的技术有那些,描述他们之间是怎么协同运作的。四、功能模块设计描述系统有那些主要功能,这些功能应该用何种技术,大致是如何实现的五、接口设计六、应急系统设计七、安全设计描述系统应该具有的安全级别,以及达到此安全等级的所采用的技术措施八、运行环境设计从硬件网络方面描述概要设计的目的就是希望一个从来没有接触过的人一看就能从各个方面都对系统的作用,功能,实现方面有一个大概了解,并为以后的各类详细设计文档提供一个指引和方向。
系统概要设计怎么写
是软件的概要设计么?
网上应该到处都有的,我以前也会打过一样的问题
给你一个我以前用的吧~
概要设计说明书
1引言
1.1编写目的
说明编写这份概要设计说明书的目的,指出预期的读者。
1.2背景
说明:
a. 待开发软件系统的名称;
b. 列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站(中心)。
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料
列出有关的参考文件,如:
a. 本项目的经核准的计划任务书或合同,上级机关的批文;
b. 属于本项目的其他已发表文件;
c. 本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。
2总体设计
2.1需求规定
说明对本系统的主要的输入输出项目、处理的功能性能要求,详细的说明可参见附录C。
2.2运行环境
简要地说明对本系统的运行环境(包括硬件环境和支持环境)的规定,详细说明参见附录C。
2.3基本设计概念和处理流程
说明本系统的基本设计概念和处理流程,尽量使用图表的形式。
2.4结构
用一览表及框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系.
2.5功能器求与程序的关系
本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系:
程序1 程序2 …… 程序n
功能需求1 √
功能需求2 √
……
功能需求n √ √
2.6人工处理过程
说明在本软件系统的工作过程中不得不包含的人工处理过程(如果有的话)。
2.7尚未问决的问题
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
3接口设计
3.1用户接口
说明将向用户提供的命令和它们的语法结构,以及软件的回答信息。
3.2外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。
3.3内部接口
说明本系统之内的各个系统元素之间的接口的安排。
4运行设计
4.1运行模块组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运行所历经的内部模块和支持软件。
4.2运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
4.3运行时间
说明每种运行模块组合将占用各种资源的时间。
5系统数据结构设计
5.1逻辑结构设计要点
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
5.2物理结构设计要点
给出本系统内所使用的每个数据结构中的每个数据项的存储要求,访问方法、存取单位、存取的物理关系(索引、设备、存储区域)、设计考虑和保密条件。
5.3数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式:
6系统出错处理设计
6.1出错信息
用一览表的方式说朗每种可能的出错或故障情况出现时,系统输出信息的形式、含意及处理方法。
6.2补救措施
说明故障出现后可能采取的变通措施,包括:
a. 后备技术说明准备采用的后备技术,当原始系统数据万一丢失时启用的副本的建立和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术;
b. 降效技术说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需结果的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记录;
c. 恢复及再启动技术说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软件从头开始重新运行的方法。
6.3系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 各个程序之间的对应关系,可采用如下的矩阵图的形式;
为什么要写软件概要设计说明书
必须的。方便管理和后期研发的项目把控。
那概要设计说明书的目的怎么写,读者对象是谁?
设计来干啥用的就是啥目的。读者对象得看你那软件的用途。开发者和管理层肯定会过目。其它就看会不会牵涉到使用者咯。 你可以在网上搜一些说明书的范例做参考。
软件概要设计说明书
.编写目的
编写此需求分析报告,实现商场、中小企业或个人在互联网上进行新产品展示,网上通信留言功能,重点实现网上商品的查找、在线购买功能。实现普通用户只能浏览,注册用户可以在线定购,后台管理人员可以进行产品上传更新、注册用户的管理等功能。
1.2.项目背景
项目名称:ASP网上购物系统
项目委托单位: hyst105040701
项目开发单位:040701班
项目简介:本系统主要实现网上产品展示与在线定购及人员的管理,一、不同身份有不同的权限功能(管理人员、注册用户、游客) 二、在线产品展示(分页显示) 三、在线定购 四、后台管理(用户管理、商品的管理)
(本系统为040701班的毕业设计项目)
1.3.问题陈述
对用户提供的服务有:
l 在线产品展示
l 在线查找功能
l 在线下订单。
l
2.任务概述
2.1.需求概述
2.1.1.在线展示
只要登录到网站后,就可以在线浏览展示商品,
最新商品动画展示
在线购买商品从后台数据库动态显示商品图片与产品名。
单击产品名或图片就看到产品的详细介绍。要添加购买与收藏功能。
2.1.2.在线下订单:
只有注册用户才能利用该系统下订单。注册后并且处于激活状态才可以购物下订单。非注册用户和处于非激活状态的用户,只能浏览商品的基本情况。用户登录后,就可以使用系统提供的各种功能。
单击产品对应的购买按钮后,要显示购物车界面,在该界面中要实现购买产品数量统计、总价格统计及每种产品的购买时间。
在购物车中,可以实现继续购买、产品数量的修改、删除购买物品、到收银台付款功能。
在信息填写与提交中,要实现“返回上一步”修改功能,实现所以信息统计界面。实现产生订购单号功能。
2.1.3后台管理服务
管理员修改功能
商品管理功能
会员管理功能
2.1.4留言功能
2.2.运行环境
服务器端: ASP+SQLSERVER2000+IIS 5.0
客户端: IE浏览器
2.3.开发环境
SQLServer数据库+IIS5.0+Windows2000+Dreamweaver2004
2.5.限制和约束
l 一个客户在系统中只有一个账号。
l 客户要想购物必须先登陆。
l 管理员只能进行三次登录
3.总体设计
3.1.参与者(不同使用身份)
Ø 游客
Ø 注册用户
Ø 管理员
3.2购物流程
1) 注册用户(注:在欢迎页面,未登陆的用户可浏览商品信息)
2) 用户登陆(注:在欢迎页面)
3) 浏览商品信息
4) 选择购物和数量(攒机或是单一购买)
5) 选择付款方式(如汇款定单状态默认为3)
6) 确定购买(插入数据库购物单表)
7) 系统处理购物单表插入定单表并设置1,(返回订单id)
8) 定单查询(可按定单号和全部查询),定单状态为1、3的可以取消,状态为6的付款方式为货到付款的可以取消。
9) 定单收到后,由客户签字,把定单状态改为2
3.3系统管理员流程
1) 登陆
2)修改管理员密码
3)会员用户的删除、修改、添加
4)商品的添加,
5)购买商品的浏览、删除与更新
4 数据描述
本系统中共有6张表,管理员表、用户信息表、产品表、产品类型表、购物单表、留言表。每种表具体字段及类型见下表:(可以根据自己的需要增加表,但主要表的字段不能少。)
管理员表-admins
字段名 字段 类型 长度 说明
管理员ID u_id 自增 not null 主
姓名 u_Name varchar(10) not null 10
密码 u_Pwd char(8) not null 定长 8
用户信息表-userInfo
字段名 字段 类型 长度 说明
用户名 u_Name varchar(10) 10 主
真实姓名 u_TrueName varchar(8) 8
身份证号 u_IDcard char(18) not null 18 定长
性别 u_Sex char(2) not null 2 定长
年龄 u_Age tinyint not null 2
住址 u_Add nvarchar(40) not null 40
联系电话 u_Tel char(11) not null 11 定长
邮编 u_ Postalcode char(6) not null 6 定长
E-mail u_Email varchar(40)
备注 u_Remark nvarchar(100)
产品表-goods
字段名 字段 类型 长度 说明
商品ID 1.1 goods_id char(2) 主
商品类型ID 1.1 goodsType_id char(2) not null 外
商品名 goods_name nvarchar Not NULL 8
价格 goods_price smallmoney not null 18
会员价 Goods_price1 nvarchar(40) 80
图片 goods_photo varchar(80) 80 图片的位置
描述 goods_depict nvarchar(100) 200
产品类型表-goodsType
字段名 字段 类型 长度 说明
1.1 商品类型ID 1.1 goodsType_id char(2) not null
概要设计和详细设计怎么写 知乎
撰写的设计文档主要分为:总体概要设计文档 + 详细设计文档,后简称为“概设”+“详设”。
总设和详设都应该包含的部分:
(1) 需求:一般以产品的语言描述,这一块可以拷贝产品需求文档中的story list部分;
(2) 名词解释(可选):非相关领域内的同学需要看到文档需要提前了解的一些概念性质的东西;
(3) 设计目标:又分为功能目标和性能目标,功能目标一般是对产品需求的技术描述,性能目标是根据产品给出的数据对性能进行的评估。一般来说,新服务必须要有性能目标一项,性能目标可能会影响设计方案。
除了都应该包含的部分,总体概要设计一般还包含:
(1) 系统架构:一般来说会有个简单的架构图,并配以文字对架构进行简要说明;
(2) 模块简介:架构图中如果有很多模块,需要对各个模块的功能进行简要介绍;
(3) 设计与折衷:设计与折衷是总体概要设计中最重要的部分;
(4) 潜在风险(可选);
输出总体概要设计的时候,很多方案还是不确定的,需要在设计评审会议上确认。
总体概要设计重点在“方案折衷”,总体概要设计评审完毕之后,此时应该是所有方案都确认了,需要输出各模块的详细设计,详细设计重点在“详细”:
(1)总体概要设计结论汇总(可选):达成一致的结论有个简要概述,说明详设是对这些结论的实现;
(2)交互流程:简要的交互可用文字说明,复杂的交互建议使用流程图,交互图或其他图形进行说明;
(3)数据库设计:这个是应该放在总设还是详设呢?
(4)接口形式:有了数据库+接口+流程,别的同学拿到详设文档,基本也能够搞定了;
(5)其他细节:例如公式等;
理论上输出了详细设计之后,无论谁拿到了这个详设文档,都是能够完成该项目的。
个人实践分享:
一、 大图
(1) 大系统或复杂流程,其架构图或者流程图会非常大,经常比A4纸或word的一页大很多,此时不宜在word中直接贴图形,贴了也看不清,建议将图放在wiki上,文档中直接贴链接;
(2) 一定要保存viso或者其他图形的源文件,否则今后改动起来要重画,代价可想而知;
二、 设计与折衷
(1) 设计与折衷是总设中最重要的内容,总设评审中,主要就是讨论这些折衷的优劣;
(2) 评审过后,不但要邮件周知结论,还要在总设中进行更新,说明最终决定使用了哪种方案,为什么使用这种方案;根据自己的经验,接手别人的模块、项目,拿到代码和文档,设计方案对我来说完全是个谜!!!
(3) 有时候因为排期或者其他原因,不一定采用了最优的设计方案,此时更应该在总设中记录决策的过程与原因;
(4) 最后,设计折衷是一个很好的自我辩解的机会:因为项目进度,或者历史遗留问题,我不得不采取了一个这样的设计,不要再骂我了。
三、 性能目标
性能目标是新模块文档必不可少的一部分,很多项目对性能影响较大的话,也必须撰写性能目标,性能一般来说可能包含以下部分:
(1) 日平均请求:一般来自产品人员的评估;
(2) 平均QPS:日平均请求 除以 4w秒得出,为什么是4w秒呢,24小时化为86400秒,取用户活跃时间为白天算,除2得4w秒;
(3) 峰值QPS:一般可以以QPS的2~4倍计算;
互联网公司,产品迭代块,项目周期长,基本没有“文档”一说,但其实写好文档,对系统和项目未来的维护是非常有帮助的。
转载请注明出处51数据库 » 软件概要设计要怎么写 软件文档中概要设计如何写