系统设计规范文档格式.docx

系统设计规范文档格式.docx

《系统设计规范文档格式.docx》由会员分享，可在线阅读，更多相关《系统设计规范文档格式.docx（9页珍藏版）》请在冰豆网上搜索。

部门

职务

日期

状态*

说明

Email/电话

*状态类别：

批准，复审状态，通知，存档，参加会议，其它（请指明）

版本记录

版本编号

版本日期

章节

类型

作者

文件名

说明：

类型----创建（C）、修改（M）、增加（A）、删除（D）；

版权声明

本文档XX许可，不得随意拷贝或转载。

1.

概述

1.1.目的

本文提供概要设计人员在编写概要设计说明书的规范准则，也可以作为评审人员的审核依据。

1.2.适用范围

该标准适用于所有参与新系统开发的系统设计人员。

2.提交成果物

●概要设计书

●相关规则说明书

●MSG说明书

●EA项目工程文件

●数据模型PDM文件

3.文档规范

3.1.需求参考

指出所参考的需求规格说明书名称和位置，例如：

/S01核心系统/01产品库/01产品文档/02需求文档/03需求分析/影像/GH-SEP-CORE-IMG-需求规格说明书-影像系统架构-V1.0.doc

3.2.模板参考

/02规范标准/03设计规范/GH-SEP-概要设计书-修订模板-v1.0

3.3.文档划分

如果系统是由相对独立（架构体系上或功能实现上）的功能模块构成，可以使用多篇设计文档来编写。

3.4.文档目录结构

具体参考《项目配置管理规范》文档配置章节

3.5.词汇表

词汇表是必须的，列出架构设计中用到的专门术语的定义和外文的首字母组词的原词组等。

例如：

词汇

释义

JQurey

一种基于JavaScript的开源通用类库

JQureyUI

基于JQuery的页面样式组件库

JSON

JSON（JavascriptObjectNotation）是一种轻量级的资料交换语言，以文字为基础，且易于让人阅读

AJAX

全称为“AsynchronousJavaScriptandXML”（异步JavaScript和XML），是一种创建交互式网页应用的网页开发技术

3.6.系统用例

建议使用EA软件工具UML用例图来表述，其要点如下：

●列出系统的所有参与者

●清晰描述系统的参与者与用例之间的关系

3.7.系统组件

建议使用EA软件工具UML组件图来表述，其要点如下：

●列出系统的所有构成组件

●清晰描述组件之间的交互关系

3.8.系统部署

用于描述系统完成后将部署在什么样的运行环境，目前修订为指出架构设计部署文档引用出处，请参照以下示例统一书写。

示例：

具体见架构设计部署文档，参见版本库“新系统/S01核心系统/02产品库/01产品文档/03设计文档/03模型设计/系统架构图/”目录。

3.9.系统间时序图

建议使用EA软件工具UML时序图来表述，其要点如下：

●如果含有多个子系统，清晰描述系统间构成元素之间的调用关系

3.10.类图及类描述

建议使用EA软件工具UML类图来表述，其要点如下：

●列出系统的所有构成类

●清晰描述系统构成类之间的关联关系

3.11.存储过程

采用单独设计文档来描述，具体参照数据库设计规范

3.12.DTO

●列出系统的所有构成DTO类

●清晰描述DTO的主要属性

3.13.时序图

●列出系统的所有构成元素

●清晰描述系统构成元素之间的调用关系

3.14.数据流图

目前使用Visio软件工具数据流图来表述，其要点如下：

●列出系统的所有数据存储介质，包括数据库和文件等

●清晰描述表、关键字段的状态

3.15.接口说明

本系统调用的外部接口清单描述，采用单独设计文档来描述，具体参照接口设计模板说明。

3.16.批处理说明

本系统使用的批处理描述，其要点如下：

●提供批处理启动参数说明

●提供批处理启动方式说明

●提供批处理事务处理说明

3.17.数据模型

建议使用PowerDesigner软件工具PDM图来表述，其要点如下：

●列出系统的所有构成表及关联关系

●清晰描述表字段名称、字段类型、字段长度、字段规则等

3.18.空白章节

如果文档章节无内容请填写无或加注待补充字样

4.EA分布式开发

通过XMIImport/Export功能可以在开发团队中共享XML，以达到以下目的：

●可以装配模型的任意需要的一部分

●可以按需要装配整个模型

●过程可以使用版本控制系统进行控制

使用方法：

Project|Import/Export