详细设计说明书

详细设计说明书有限公司

变更记录目录文档介绍（标题1、宋体、三号、加粗） 错误！未定义书签。TOC\o"1-5"\h\z文档目的（标题 2、宋体、小三、加粗） 1文档范围 1\o"CurrentDocument"读者对象 1\o"CurrentDocument"参考文献 11.5.术语与缩写解释 错误！未定义书签。\o"CurrentDocument"1.6. 原型图例说明 2\o"CurrentDocument"1.7. 系统设计编号规则 2\o"CurrentDocument"1.7.1.功能点编号规则 21.7.2.表格中的项目编号规则 2\o"CurrentDocument"系统概述 3\o"CurrentDocument"设计约束 3\o"CurrentDocument"设计策略 3\o"CurrentDocument"系统总体结构 4\o"CurrentDocument"模块命名规则 4\o"CurrentDocument"模块汇总表 4\o"CurrentDocument"子系统总体设计 5\o"CurrentDocument"FUNC_01子系统英文简称：子系统1名称 5数据模型（标题3、宋体、四号、加粗） 5模块关系图 5\o"CurrentDocument"FUNC_02子系统英文简称：子系统2名称 5\o"CurrentDocument"数据模型 5模块关系图 6\o"CurrentDocument"子系统模块详细设计 6\o"CurrentDocument"FUNC_XXMW功能块 6\o"CurrentDocument"FUNC_XXMW_XX功能分类 6\o"CurrentDocument"开发环境的配置 8\o"CurrentDocument"运行环境的配置 9\o"CurrentDocument"测试环境的配置 91前言1.1.文档目的提示：描述文档目的（正文，宋体，五号，非加粗）1.2.文档范1.2.文档范提示：描述文档适用的业务范畴读者对象提示：文档的使用对象提示：描述文档适用的业务范畴读者对象提示：文档的使用对象参考文献提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下[标识符]作者，文献名称，出版单位（或归属单位），日期例如：[AAA]作者，《立项建议书》，机构名称，日期[SPP-PROC-SD]SEPG，系统设计规范，机构名称，日期名称术语提示：文档中所有表格字体统一为宋体、小五、非加粗原型图说明提示：设计原型的工具不做统一规定，但是一个系统的原型图例样式、界面风格要保持一致，要在此章节进行必要的约定和说明。系统设计编号规则1.7.1.功能点编号规则子系统1：FUNC_01子系统英文简称功能模块1.1：FUNC_01子系统英文简称_01功能点1.1.1：FUNC_01子系统英文简称_0101子系统2：FUNC_02子系统英文简称1.7.2.表格中的项目编号规则1）第一级a）第二级b）第二级i.第三级ii.第三级2）第一级提示：（1）尽量避免在出现三级和三级以上的项目编号；（2）如果各项目编号之间有先后关系，在项目编号后加上步骤1，步骤2的描述。但是建议在操作序列一栏中用流程图表示，文字说明只是做补充。（3）不要试图用大段的文字来描述复杂的程序处理流程。（4）如果要分别说明不同业务处理的业务规则或者操作序列建议用以下编号规则：业务处理11） 第一级步骤12） 第一级步骤2系统概述提示：（1）说明本系统“是什么”，（2）描述本系统的主要功能。2.1设计约束提示：（1）需求约束。体系结构设计人员从需求文档（如《用户需求说明书》和《软件需求规格说明书》）中提取需求约束，例如：本系统应当遵循的标准或规范软件、硬件环境（包括运行环境和开发环境）的约束接口/协议的约束用户界面的约束软件质量的约束，如正确性、健壮性、可靠性、效率（性能）、易用性、清晰性、安全性、可扩展性、兼容性、可移植性等等。（2）隐含约束。有一些假设或依赖并没有在需求文档中明确指出，但可能会对系统设计产生影响，设计人员应当尽可能地在此处说明。例如对用户教育程度、计算机技能的一些假设或依赖，对支撑本系统的软件硬件的假设或依赖等。2.2设计策略提示：体系结构设计人员根据产品的需求与发展战略，确定设计策略。例如：扩展策略。说明为了方便本系统在将来扩展功能，现在有什么措施复用策略。说明本系统在当前以及将来的复用策略。折衷策略。说明当两个目标难以同时优化时如何折衷，例如“时－空”效率折衷，复杂性与实用性折衷。2.3系统总体结构提示：将系统分解为若干子系统，绘制物理图和逻辑图，说明各子系统的主要功能。说明“如何”以及“为什么”(howandwhy)如此分解系统。说明各子系统如何协调工作，从而实现原系统的功能。可参考《软件需求规格说明书》中的系统总体结构图，对前者功能的细化，从不同的角度描述系统总体结构2.4模块命名规则提示：模块设计人员确定本软件的模块命名规则(例如类、函数、变量等)，确保模块设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用(如果存在的话)。2.5模块汇总表提示：(1)这里的模块是指相对独立的软件设计单元，将整个软件系统先分成几个相对独立的子系统，再将各子系统划分不同的功能模块以及小的功能点。(2)子系统的划分可参考《软件需求规格说明书》中业务项的划分FUNC_O1子系统英文简称：子系统1名称模块名称功能简述FUNC_O1子系统英文简称_01FUNC_02子系统英文简称：子系统2名称模块名称功能简述FUNC_02子系统英文简称_01子系统总体设计3.1FUNC_01子系统英文简称：子系统1名称3.1.1数据模型（标题3、宋体、四号、加粗）提示：系统统一以PDM文件描述子系统的数据模型3.1.2模块关系图提示：（1）将子系统分解为模块（Module），绘制逻辑图（如果物理图和逻辑图不一样的话，应当绘制物理图），说明各模块的主要功能。（2）说明“如何”以及“为什么”（howandwhy）如此分解子系统。（3） 说明各模块如何协调工作，从而实现子系统的功能。3.2FUNC_02子系统英文简称：子系统2名称3.2.1数据模型提示：系统统一以PDM文件描述子系统的数据模型，如果文件比较庞大，可以考虑只将核心表结构展示到文档中。3.2.2模块关系图提示：将子系统分解为模块(Module)，绘制逻辑图(如果物理图和逻辑图不一样的话，应当绘制物理图)，说明各模块的主要功能。说明“如何”以及“为什么”(howandwhy)如此分解子系统。说明各模块如何协调工作，从而实现子系统的功能。子系统模块详细设计4.1FUNC_XXMW功能块4.1.1FUNC_XXMW_XX功能分类4.1.1.1FUNC_XXMW_XXXX功能名称♦功能概述功能描述…。♦功能点列表功能点名称描述功能点名称功能点描述。功能规则无。规则描述无。♦功能设计◊功能点名称

功能点名称：功能点名称界面原型提示：如果是前台功能，通过visio或者其他工具绘制界面原型，如果不是前台功能则为空。本次开发设计采用visio绘制界面原型页面校验提示：通过序号方式一一阐述校验规则和约束*号必输项、默认登录人等信息不在此罗列，由开发规范明确操作序列提示：可以通过流程图方式或者文字描述业务操作的序列包括前台操作流程和后台处理流程图：查询、增加、修改、删除、明细等具有简单操作的按钮不在此罗列，由开发规范明确；复杂业务需后台处理图依赖功能列出需要调用的模块间的功能名称、参数信息（接口）处理详细描提示：对于复杂的功能，需要详细描述的，在此处补充；一般情况下，操作序列为流述程图时，此处作为详细说明的补充。1.{a.b.}2.{a.b.}{c.d.

}3.具体开发中用到的方法名不用描述，只需描述处理思路，不能照搬需求规格说明书提供功能列出给其他功能提供的模块间的功能名称、参数信息数据操作功能描述输入参数输出参数业务规则提示：对应功能点列表的功能点2中的子功能名称提示：对应功能点列表的功能点2中的子功能名称关键SQL功能描述SQL语句提示：对应功能点列表的功能点2中的子功能名称提示：如果sql语句在功能点内部还需要拆分成多个，建议以以下方式：sqll:select1fromdual;单表操作的SQL不用列出SQL语句，有需要明确的检索条件时，在数据操作的业务规则中描述5开发环境的配置提示：说明本系统应当在什么样的环境下开发