概要设计书的内容:
----------------------------------------------------------------------------------------------------
1.画面设计
通常包括画面的sample和针对画面的简单说明。
画面的sample可以通过visio制作,也可以使用excel等的绘图功能制作,还可以开发系统后运行系统,显示画面并截图。
2.画面项目定义
对于画面的form,画面上显示的控件的详细说明。包括控件的名称,类型,各个属性的值,以及相关的数据库字段等。如:
No. | 名称 | 类型 | 文字数 | 数据裤字段 | 说明 |
1 | 职工名 | textbox | 50 | [employee].[name] | 职工的名称,允许输入文字,不允许输入数字 |
3.流程图
画面之间的移动,画面和batch的启动关系,画面和数据库的关联,batch和数据库的关联,数据的流向等。
这是为了表示画面/batch在整个系统中的作用,以及和哪些其他功能(画面/batch)有关,也能表示画面/batch使用了哪些数据库对象,如表,视图,procedure,function,trigger等。
一般都会在流程图的旁边注明相关数据库对象的名称,如果想达到详细说明的效果,最好说明画面/batch对于数据库对象进行的是什么样的操作,如:
调用:针对procedure,function,trigger等。
I/O:针对表/视图等。即从表/视图等读取数据或写入,更新,删除数据。最好指明设计的表/视图的字段。
4.事件处理一览表
列出画面中发生的所有事件,指定如何处理,事件处理后应该得到什么样的结果,处理后画面的状态等。如:
事件名称 | 触发方式 | 处理方法 |
查询 | 用户点击[查询]按钮 | 在画面的表格中显示出所有符合条件的查询结果 |
5.各种事件处理的详细说明
在事件处理一览表中的处理说明只是概要说明,所以需要另外的文档说明每个事件的详细处理要求。如:
<文档1>查询事件处理
1.根据用户输入的条件查询。
查询对象:表t1,视图t2
连接条件:t1.cola = t2.colb
查询条件:t1.name like 用户输入的名称 and t2.age > 用户输入的年龄
选取字段:t1.col1,t2.col3
显示顺序:t1.colc asc, t2.cold desc
2.查询结果显示到画面的表格中。
如果结果总数 <= 100 条,全部显示。
如果结果总数 > 100 条,分页显示,每页100条。
3.显示数据总条数。
6.数据库处理逻辑
如果画面/batch的调用的procedure,function等很复杂,就需要认真设计数据库处理逻辑。
通常使用流程图来描述复杂的数据库处理逻辑。
7.补充说明
画面显示给用户的提示信息一览表,相关数据库对象说明(如表的字段定义)等。如:
1.提示信息一览表:
非法用户登录 | [您没有访问权限!请先注册] |
数据库连接失败 | [数据库连接失败!请联系系统管理员] |
2.数据库对象说明--->数据库字段更新说明
用户点击[更新]按钮时应该更新
表:s1
字段:
col1-->用户输入值
col2-->用户输入值
col3-->系统时间