系统设计文档模版教程.docx

系统设计说明书OCCS网站2014年04月文档信息文档名称系统设计说明书描述当前状态目录1.引言41.1.目的41.2.背景41.3.定义41.3.1.缩略语41.3.2.专业术语定义41.4.规范说明41.4.1.组件规范说明（不可修改）41.4.2.页面规范说明（不可修改）52.总体设计62.1.系统层次结构图62.2.系统交易一览62.3.系统角色设计62.4.其他设计62.5.公用字段说明63.交易设计63.1.模块中文名称（模块英文名称）63.1.1.交易名称64.接口设计104.1.外部接口104.2.内部接口105.运行设计105.1.系统权限设计105.2.运行控制106.数据结构设计107.参考资料清单10引言目的背景定义缩略语缩略语英文全名中文全名例：SPService Provider服务提供商专业术语定义规范说明组件规范说明（不可修改）组件名称：即组件中文名称，作为查看使用。命名规范如下：组件具有查看、增加（新建）、更新，删除动作功能时，采用动作+动作对象的方式命名，如：新建企业客户；组件具有列表功能时，采用列表内容+列表的方式命名，如：企业客户列表。组件代码：即组件英文名称，作为函数名使用。命名规范：采用英文缩写方式，第一个英文意思的首字母小写，后面每个英文意思的首字母大写。操作命名规范示例说明查询记录列表get对象名List[By][IndexName]getComCusListgetComCusListById查询单条记录get对象名getComCus更新记录update对象名updateComCus删除记录delete对象名deletComCus增加记录insert对象名insertComCus处理记录save对象名saveComCus同时包括对数据对象的增、删、改、查操作中两项或两项以上的判断信息validate对象名validateComCus数据访问：列出此组件所要访问的表及动作。选择(S)，增加(I)，更新(U)，删除(D)，列表(L)。输入输出（IO）：可以是基本类型，也可以是对像。原则上要稳定，不能因业务改动而影响组件接口变化，一般输入参数不要超过5个。输入输出如是对像，请指明对像的哪些属性，如有多个对像参数，分别说明。页面规范说明（不可修改）页面名称：页面名称分为中文名称和英文名称。查看、增加（新建）、更新、删除等功能页面时，采用动作+动作对象的方式命名，如：中文名称：新建企业客户；英文名称：insertComCus.jsp页面布局：从组件化平台的现有模式中进行选择。布局模式：单表维护、查询、单个表单、单个列表、单表维护带查询、多个列表有按钮等模式总体设计系统层次结构图系统交易一览模块名称交易名称交易描述系统角色设计角色名称角色描述其他设计公用字段说明交易设计模块中文名称（模块英文名称）交易名称（模块中顺序：1）操作步骤：请描述交易的具体操作过程。业务流程图页面布局页面中文名称布局方式（即页面模版）动作按钮【菜单链接/按钮/超链接】业务动作按钮所属表单（或列表）注：1、当多个动作按钮属于同一个页面时，页面和布局方式进行单元格合并，只出现一个页面和布局方式。2、一个交易中必须要有一个菜单链接动作。（必须有）例：动作按钮【菜单链接/按钮/超链接】:初始化【菜单链接】业务动作：页面事件业务动作：XXXXXXX输入要素页面显示名称数据表中字段名称字段所在表名特殊字段属性（具体属性请参照组件化平台）设置字段属性具体值若字段不属于表中字段则不用填若字段不属于表中字段则不用填若没有特殊属性则不用填若没有特殊属性则不用填注：1、特殊字段属性指的是字段属性在系统默认的情况下不能满足要求，需要对属性的信息进行特别改动才符合要求。2、字段属性名称包括：表单：标签名称、字段名称、字段类型、定义范围、行次、标签列次、字段列次、标签对齐、跨行数、标签跨列数、字段跨列数、字段对齐、标签宽度、标签样式、标签链接、文字方向、字段宽度、字段样式、尺寸/选项、数据类型、初值、最大长度、单位、是否必输、字段说明、onblur、参数、是否只读、onclick、按纽名字、onchange、参数2、onkeyup、onkeydown、onkeypress、ondblclick、onmousedown、onmouseout、onmousemove、onmouseover、onmouseup、onselect、是否ajax搜索、onfocus；列表：列名称、字段名、宽度、对齐、列顺序、类型、参数、链接样式、行数、跨行数、跨列数 各个字段属性名称的详细信息请参考组件化平台。4、当一个字段有多个属性时字段属性和详情中以#分割；如：字段名称：客户经理字段属性：初值#字段类型#参数#是否必输字段属性具体值：$getUserId$#选择域