概要设计报告模板

来源:互联网 发布:windows命令行重启电脑 编辑:程序博客网 时间:2024/05/03 06:54

一个完整的概要设计报告主要包括以下几大部分:

1、系统总体设计

简要描述系统的目的、主要功能及约束条件。细分为系统总体设计思想,系统总体设计结构和系统模块划分。总体设计思想说明系统设计所遵循的标准和规范,为实现需求所采取的思路,系统的可靠性、可用性如何保证等;总体设计结构通过系统结构图描述系统的总体结构(要在图中显著地区分本系统内部与外部的边界。然后,在图后面辅以文字对图中的各个部分进行说明);功能模块划分清晰描述系统的模块总体结构,在报告中描述清楚各模块/子系统的功能、界面、接口、数据存储要求、确定系统的实现概貌以作为详细设计的基础,要在图中显著地区分出本系统内部的模块/子系统和外部的模块/子系统。模块的获取开始时根据业务逻辑先做出初始的模块/子系统划分,然后描述系统各项功能的流程,在描述流程的过程中,参照上述的模块/子系统的划分原则,也许就会发现初始划分的不合理处,再根据需要修改模块/子系统的划分,这样反复迭代,就形成了合理的模块/子系统的划分。并在下图中描述各模块及功能:

2、系统功能性设计

逐个描述系统的功能性需求以及可能转化为功能性需求的质量属性需求和安全性需求的实现流程,目的是
-
明确系统功能实现的流程、
-
明确各模块/子系统的具体功能、
-
明确各模块/子系统之间的接口、
-
明确系统的外部接口。

针对每个功能给出其场景描述,一个功能通常包含多个场景,每个场景是执行这个功能的一个实例,这个实例反映了这个功能的这个场景中各个相关对象的行为和关联。一般地,我们会分析出一个功能包含哪些典型的场景,包括正常情况场景和异常情况场景,通过描述这些典型场景来充分地说明这个功能。UML顺序图(Sequence Digram)非常适合这样的场景描述。

3、接口设计

接口设计分为用户界面设计、报表设计、硬件接口设计、内部软件接口和外部软件接口。

用户界面设计给出用户界面的结构及各个界面的简要描述,如:

  用户界面结构:

第一层
第二层
第三层
第四层
工具菜单
选项
 
 
 
拼写检查
 
 
 
录制新宏
 
 
 
案例性
 
格式菜单
段落
 
 
 
字体
 
 
 
 
 
 

用户界面描述:

 

简介
接受销售人员录入的销售数据
应用场合
收银员接受顾客买单请求
主要部件
日期时间,文本标签。精确到秒,每秒刷新一次。
购物清单,表格。包括 ID、品名、数量、单价、小计等项。
费用合计,文本标签。
打印单据,复选框。
接受,按钮。
取消,按钮。
主要操作
收银员通过条码扫描仪录入顾客提交的物品。每项物品一行,显示在 购物清单 中。收银员可手工在 购物清单 中进行录入和修改。
费用合计 显示 购物清单 中列示的物品的总金额。
收银员按 取消,系统放弃当前的买单请求并关闭本用户界面。
收银员按 接受,系统接受本次买单请求,如果 打印单据 被选上系统会打印购物单据,最后系统关闭本用户界面。
数据来源
日期时间,系统服务器的时间。
购物清单 中的 ID,条码扫描仪。
购物清单 中的 品名,品名表。
购物清单 中的 单价,单价表。
备注
 

UML交互图(Interaction Diagram)非常适合用户界面设计。

硬件接口设计描述系统中重要的硬件接口的概要特征。尤其注意系统内部、系统外部的各个硬件设备,并考虑它们之间如果进行硬件连接。

结合客户需求,把 功能性设计 中的每个场景顺序看一遍,尤其注意系统外部的角色与系统的交互活动,列出一张外部软件接口的列表;尤其注意系统内部模块/子系统之间的交互活动,列出一张内部软件接口的列表。

4、数据库设计

包括总体设计原则,其中要说明要建立几个数据库,存放数据的安全性及可靠性要求等等。

数据关联设计描述系统中重要的数据库表/视图之间的关联。如在下表中说明数据库表或视图:

5、质量属性设计

名称
类型
内容
安全性
说明
101
 
 
 
 
 
102
 
 
 
 
 
103
 
 
 
 
 
 
 
 
 
 
 

 

这一节是为了实现 需求规格说明书 中的质量属性本设计中需要特殊考虑的事项。一般情况下,需求规格说明书 中的质量属性中的大多数已在本文前面各节的设计中考虑到了。例如,易用性要求已在 用户界面设计 中考虑到了,性能、容量和可靠性要求已在 硬件总体结构 中考虑到了,可维护性要求可能已在 系统结构设计、系统功能性设计 中考虑到了。因此,这里仅描述那些仍未能体现在本文其它节中的特殊的质量属性的实现。

6、安全性设计

这里主要考虑权限控制、操作日志等内容

7、系统异常处理

 

序号
异常
处理
1
信息中心瘫痪(例如,遭遇停电、地震、硬件损坏 等)
后备信息中心接替信息中心继续工作
2
 
 
 
 
 
 

8、开发环境说明

开发本系统所使用的主要工具、语言、开发平台硬件配置等说明。

9、遗留问题及其他

功能模块标识
功能模块名称
功能简述
对应的需求标识
对应的需求名称
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

UML用例图(Usecase Diagram)非常适合功能模块的描述

原创粉丝点击