系统设计文档模版.docx
《系统设计文档模版.docx》由会员分享，可在线阅读，更多相关《系统设计文档模版.docx（10页珍藏版）》请在冰豆网上搜索。
系统设计文档模版
系统设计
说明书
OCCS网站
2014年04月
文档信息
文档名称
系统设计说明书
描述
当前状态
1.
引言
1.1.目的
1.2.背景
1.3.定义
1.3.1.缩略语
缩略语
英文全名
中文全名
例：
SP
ServiceProvider
服务提供商
1.3.2.专业术语定义
1.4.规范说明
1.4.1.组件规范说明（不可修改）
组件名称：
即组件中文名称，作为查看使用。
命名规范如下：
1）组件具有查看、增加（新建）、更新，删除动作功能时，采用动作+动作对象的方式命名，如：
新建企业客户；
2）组件具有列表功能时，采用列表内容+列表的方式命名，如：
企业客户列表。
组件代码：
即组件英文名称，作为函数名使用。
命名规范：
采用英文缩写方式，第一个英文意思的首字母小写，后面每个英文意思的首字母大写。
操作
命名规范
示例
说明
查询记录列表
get对象名List[By][IndexName]
getComCusList
getComCusListById
查询单条记录
get对象名
getComCus
更新记录
update对象名
updateComCus
删除记录
delete对象名
deletComCus
增加记录
insert对象名
insertComCus
处理记录
save对象名
saveComCus
同时包括对数据对象的增、删、改、查操作中两项或两项以上的
判断信息
validate对象名
validateComCus
数据访问：
列出此组件所要访问的表及动作。
选择（S），增加（I），更新（U），删除（D），列表（L）。
输入输出（IO）：
可以是基本类型，也可以是对像。
原则上要稳定，不能因业务改动而影响组件接口变化，一般输入参数不要超过5个。
输入输出如是对像，请指明对像的哪些属性，如有多个对像参数，分别说明。
1.4.2.页面规范说明（不可修改）
页面名称：
页面名称分为中文名称和英文名称。
查看、增加（新建）、更新、删除等功能页面时，采用动作+动作对象的方式命名，
如：
中文名称：
新建企业客户；
英文名称：
insertComCus.jsp
页面布局：
从组件化平台的现有模式中进行选择。
布局模式：
单表维护、查询、单个表单、单个列表、单表维护带查询、多个列表有按钮等模式
2.总体设计
2.1.系统层次结构图
2.2.系统交易一览
模块名称
交易名称
交易描述
2.3.系统角色设计
角色名称
角色描述
2.4.其他设计
2.5.公用字段说明
3.交易设计
3.1.模块中文名称（模块英文名称）
3.1.1.交易名称（模块中顺序：
1）
1.操作步骤：
请描述交易的具体操作过程。
2.业务流程图
3.页面布局
页面中文名称
布局方式
（即页面模版）
动作按钮
【菜单链接/按钮/超链接】
业务动作
按钮所属表单
（或列表）
注：
1、当多个动作按钮属于同一个页面时，页面和布局方式进行单元格合并，只出现一个页面和布局方式。
2、一个交易中必须要有一个菜单链接动作。
（必须有）
例：
动作按钮【菜单链接/按钮/超链接】:
初始化【菜单链接】
业务动作：
页面事件
4.业务动作：
1）XXXXXXX
a）输入要素
页面显示名称
数据表中字段名称
字段所在表名
特殊字段属性
（具体属性请参照组件化平台）
设置字段属性具体值
若字段不属于表中字段则不用填
若字段不属于表中字段则不用填
若没有特殊属性则不用填
若没有特殊属性则不用填
注：
1、特殊字段属性指的是字段属性在系统默认的情况下不能满足要求，需要对属性的信息进行特别改动才符合要求。
2、字段属性名称包括：
表单：
标签名称、字段名称、字段类型、定义范围、行次、标签列次、字段列次、标签对齐、跨行数、标签跨列数、字段跨列数、字段对齐、标签宽度、标签样式、标签链接、文字方向、字段宽度、字段样式、尺寸/选项、数据类型、初值、最大长度、单位、是否必输、字段说明、onblur、参数、是否只读、onclick、按纽名字、onchange、参数2、onkeyup、onkeydown、onkeypress、ondblclick、onmousedown、onmouseout、onmousemove、onmouseover、onmouseup、onselect、是否ajax搜索、onfocus；
列表：
列名称、字段名、宽度、对齐、列顺序、类型、参数、链接样式、行数、跨行数、跨列数
各个字段属性名称的详细信息请参考组件化平台。
4、当一个字段有多个属性时字段属性和详情中以#分割；
如：
字段名称：
客户经理
字段属性：
初值#字段类型#参数#是否必输
字段属性具体值：
$getUserId$#选择域（组件）#formControlService|getDmdUserInfoList|#是
b）操作要素
请描述业务动作中的具体业务流程。
如：
1、从哪里获取数据，获取的数据如何存放,如何
2、获取数据后，是否需要特殊赋值
3、页面按钮是什么状态“显示”或者“隐藏”
4、页面处于什么样的状态“只读”或“客编辑”
5、获取数据后，依次执行什么内容，数据进行什么样的处理，调用哪个组件，访问哪个数据表
4、如何返回数据，返回数据后是否有提示。
c）输出要素
页面显示名称
数据表中字段名称
字段所在表名
特殊字段属性
（具体属性请参照组件化平台）
设置字段属性具体值
若字段不属于表中字段则不用填
若字段不属于表中字段则不用填
若没有特殊属性则不用填
若没有特殊属性则不用填
注：
1、特殊字段属性指的是字段属性在系统默认的情况下不能满足要求，需要对属性的信息进行特别改动才符合要求。
2、字段属性名称包括：
表单：
标签名称、字段名称、字段类型、定义范围、行次、标签列次、字段列次、标签对齐、跨行数、标签跨列数、字段跨列数、字段对齐、标签宽度、标签样式、标签链接、文字方向、字段宽度、字段样式、尺寸/选项、数据类型、初值、最大长度、单位、是否必输、字段说明、onblur、参数、是否只读、onclick、按纽名字、onchange、参数2、onkeyup、onkeydown、onkeypress、ondblclick、onmousedown、onmouseout、onmousemove、onmouseover、onmouseup、onselect、是否ajax搜索、onfocus；
列表：
列名称、字段名、宽度、对齐、列顺序、类型、参数、链接样式、行数、跨行数、跨列数
各个字段属性名称的详细信息请参考组件化平台。
4、当一个字段有多个属性时字段属性和详情中以#分割；
如：
字段名称：
客户经理
字段属性：
初值#字段类型#参数#是否必输
字段属性具体值：
$getUserId$#选择域（组件）#formControlService|getDmdUserInfoList|#是
d）输出要数所属表单（列表）信息
表单（列表）名称：
XXXX
表单（列表）号：
XXXX
e）注意事项
5.业务组件列表：
中文名称
组件方法名称
动作+数据访问对象+By+输入数据（不能超过2个）+（当有重复时，视具体业务分析加上英文数字）
组件类型
动作/判断
所属业务动作
组件难易程度
组件所属文件
模块英文名称（首字母大写）+Service
处理步骤
详细描述组件处理的业务过程。
如：
校验内容、如何操作数据库等各种业务逻辑
输入数据
对象类型
类型
变量名（即ID）
数据类型
说明（变量中文名称，特殊说明信息）
变量中文名称，特殊说明信息
输出数据
对象类型
类型
变量名（即ID）
数据类型
说明（变量中文名称，特殊说明信息）
数据访问表
修改记录
注：
在页面中出现状态的相关描述时，请用系统代码进行解释。
如：
根据action的值判断“新增”（代码：
insert）和“修改”（代码：
update）；
状态为“新增”（代码：
0）和“草稿”（代码：
1）时，具有修改权限。
6.系统选项明细设置
选项明细编号
选项名称
显示（name）
数据值（value）
7.数据转换SQL语句
语句ID
SQL语句
注：
利用“从库中选择”形成下来列表或者在列表中使用“从库选择描述”进行数据转换时，调用的SQL语句在此处展现出来。
实例：
语句ID：
getUserInfo
SQL语句：
selectbranch_idasvalue,'['||branch_id||']'||branch_nameaslabelfromsys_branchorderbybranch_id
8.变更记录与原因
9.数据表结构
4.接口设计
4.1.外部接口
[包括用户界面、软件接口与硬件接口。
]
4.2.内部接口
[模块之间的接口。
]
5.运行设计
5.1.系统权限设计
角色
系统功能
5.2.运行控制
[说明每一种外界运行控制的方式、方法和操作步骤。
]
6.数据结构设计
详情请看《XXX数据库文档》。
7.参考资料清单
列出有关的参考文件，比如：
a．本项目经核准的计划任务书或合同、上级机关的批文；
b．属于本项目的其他已发表文件；
c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
升级会员 