2014详细设计说明书模板.docVIP

产品详细设计说明书  主要内容 第1章 引言 1 1.1 文档用途 1 1.2 阅读对象 1 1.3 名词术语 1 1.4 参考资料 1 第2章 概述 2 2.1 系统概述 2 2.2 系统功能定义 2 2.3 设计约束 2 第3章 总体结构说明 3 3.1 子系统结构 3 3.2 模块程序构件结构图 4 第4章 数据模型（Data Model）设计 6 4.1 逻辑实体模型 6 4.2 表结构（物理设计） 7 4.3 视图列表 9 第5章 功能实现说明 10 5.1 业务处理类模块 10 5.2 数据流类模块 14 第6章 界面实现说明 18 6.1 模块1 18 6.2 模块2 18 引言 文档用途 【内容】 说明此文档的主要用途。 【裁剪原则】 此部分内容不允许裁剪。 阅读对象 【内容】 此文档将适合哪些人员阅读。如： 产品设计工程师 产品开发工程师 产品测试工程师 其他相关人员 【裁剪原则】 此部分内容不允许裁剪。 名词术语 【内容】 在该份文档中，为使阅读者对使用到的名词术语有一个概念性的理解，需要对一些名词进行解释。 【裁剪原则】 如果没有特别生疏的术语，此部分内容允许裁剪掉。 参考资料 【内容】 列出该文档编写时的主要参考资料。主要包括：规范、《客户需求规格说明书》、老产品设计文档、其他子系统的设计文档等。 【裁剪原则】 如果没有参考其他资料，此部分内容允许裁剪掉。 概述 系统概述 【内容】 说明此子系统“是什么”。 【裁剪原则】 此部分内容不允许裁剪。 系统功能定义 【内容】 说明此子系统实现的主要功能，可逐条说明。 【裁剪原则】 此部分内容不允许裁剪。 设计约束 【内容】 从《产品需求规格说明书》中提取需求约束。例如： 系统应当遵循的标准或规范 客户实际的软件、硬件环境条件的约束 接口/协议的约束 软件质量的约束：稳定性、可靠性、性能等。 【裁剪原则】 此部分内容不允许裁剪。 总体结构说明 子系统结构 系统内外部关系图 【内容】 采用如下图所示的模式表述下面两层关系： 内部功能模块构成 与外部模块的接口关系 【裁剪原则】 此部分内容不允许裁剪。 注：此图为举例： 功能模块简要说明 【内容】 对诸功能模块完成的功能做简要说明。 【裁剪原则】 此部分内容不允许裁剪。 依赖的外部接口 【内容】 说明各模块依赖的外部接口是什么，输入参数、输出参数、返回值等。 【裁剪原则】 此部分内容不允许裁剪。 对外提供的接口 【内容】 说明各模块对外提供的外部接口是什么，输入参数、输出参数、返回值等。 【裁剪原则】 此部分内容不允许裁剪。 模块程序构件结构图 【内容】 详细描述程序构件结构图，并做文字说明。一般是有如下两种情况需做此描述： 非中间件服务结构的后台处理进程模块（一般是异步操作等） 在前台交互式操作的模块中，引入了非中间件服务结构的部件； 【裁剪原则】 若不存在上述情况，此部分内容允许裁剪掉。 注：此图为举例： 数据模型（Data Model）设计 逻辑实体模型 【说明】 该部分的设计和开发，对于数据库环境、数据库表、字段命名规则等，应遵循《数据库设计规范》进行。对规范有例外应用的情况，需在此说明。 实体模型1 【内容】 描述本子系统核心的实体关系模型。如下图所示。要求做到： 描述每一个实体的作用，指定实体标识（ID） 对每一个relationship都要有说明，同时严格注意Mandatory(是否必须)，Cardinality(几对几关系) ER图中的每个表中应有表名、主键字段名、重要字段名等信息。重要字段虽然不是ER图本身必须的，但可以更利于理解表的属性和关系。 【裁剪原则】 此部分内容不允许裁剪。 注：此图为举例： 实体模型2 【内容】 如果有多个实体模型，需要按照上述的方式，诸一说明。 表结构（物理设计） 【内容】 此部分主要设计表结构。一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。逻辑设计中的实体大部分可以转换成为物理设计中的表，但是他们并不一定是一一对应的。 【裁剪原则】 此部分内容不允许裁剪。可以单独提供一份该子系统的表结构设计说明文档。按照如下内容组织。 表汇总 序 号 子系统 表名 中文名称和简单描述 使用 方式 1 OBS-CS OB_CM_CUSTOMER 客户信息表 公用 2 …… …… …… 3 …… …… …… …… 4 5 6 注：使用方式分为：公用（所有子系统均可访问）、自用（仅本子系统可访问）、临时。 OB_CM_CUSTOMER 表名 客户基本信息 中文名 所属子系统 日期 建表人 字段名称 中文说明 字段属性 字段长度 空值标志 备注 索引 【说明】 表的字段的来源包