xx系统详细设计说明书(中软国际).doc

文档编号：文档编号：文档编号：文档编号： xx 系系统统 详细设计说明书详细设计说明书详细设计说明书详细设计说明书 2010-03-202010-03-202010-03-202010-03-20 北京中软国际信息技术有限公司北京中软国际信息技术有限公司 xx 系统 北京中软国际信息技术有限公司 第 1 页 文档修改记录文档修改记录 序号序号版本版本修改内容修改内容修改日期修改日期修改人修改人 11.0 创建 2010-03-20 许群合 xx 系统 北京中软国际信息技术有限公司 第 2 页 目录目录 11 1.11 1.21 21 xx 系统 北京中软国际信息技术有限公司 第 1 页 1. 简介简介 1.1.目的目的 阐明此详细设计说明书详细设计说明书的目的。 1.2.范围范围 简要说明此详细设计说明书的范围：它的相关项目，以及受到此文档影响的任何其他 事物。 1.3.定义和缩略语定义和缩略语 本小节应提供正确解释此详细设计说明书详细设计说明书所需的全部术语的定义、首字母缩写词和缩 略语。这些信息可以通过引用项目词汇表来提供。 1.4.参考资料参考资料 本小节应完整列出此详细设计说明书详细设计说明书中其他部分所引用的任何文档。每个文档应标有 标题、报告号（如果适用）、日期和出版单位。列出可从中获取这些参考资料的来源。 这些信息可以通过对附录或其他文档的引用来提供。 1.5.概述概述 本小节应说明此详细设计说明书详细设计说明书其他部分所包含的内容，并解释文档的组织方式。 2. 程序系统的组织结构程序系统的组织结构 用一系列图表列出系统内的每个程序的名称、标识符和它们之间的层次结构关系 xx 系统 北京中软国际信息技术有限公司 第 2 页 2.1.物理部署物理部署 2.2.系统模块结构系统模块结构 3. 模块模块 1 3.1.子模块子模块 1 3.1.1.子模块描述子模块描述 给出对该模块的简要描述，主要说明安排设计本模块的目的、特点 3.1.2.功能功能 说明该模块应具有的功能 3.1.3.性能性能 精度、灵活性、时间的特性 3.1.4.总体流程逻辑总体流程逻辑 用图表（例如流程图、判断表等）辅以必要的说明来表示本模块的逻辑流程 3.1.5.界面类、业务类的调用关系界面类、业务类的调用关系 说明本模块中画面类、业务类之间的调用关系，可以采用序列图等形式描述 xx 系统 北京中软国际信息技术有限公司 第 3 页 3.1.6.界面逻辑设计界面逻辑设计 3.1.6.1.界面界面 1 3.1.6.1.1.前提条件前提条件 说明本画面运行所受的前提条件： 在什么条件下才能进入本画面，本画面构造函数涉 及的入参 3.1.6.1.2.画面设计画面设计 【给出设计的画面，做简要说明】 3.1.6.1.3.输入项输入项 【用户输入项（分为必填、可选），数据库获取项，配置文件获取项、全局变量获取 项】 3.1.6.1.4.输出项输出项 【转移画面，数据库修改项，配置文件修改项、全局变量修改项】 3.1.6.1.5.流程逻辑流程逻辑 用图表（例如流程图、判断表等）辅以必要的说明来表示本画面涉及的逻辑流程 3.1.6.1.6.界面类界面类 【重要的构造函数、事件、变量、方法的描述】 xx 系统 北京中软国际信息技术有限公司 第 4 页 3.1.6.1.6.1.类图类图 3.1.6.1.6.2.构造函数构造函数 3.1.6.1.6.3.变量变量 3.1.6.1.6.4.事件事件 3.1.6.1.6.5.方法方法 3.1.6.1.7.业务类业务类 3.1.6.1.7.1.业务类业务类 1 总体描述该类的属性、方法、事件/代理。建议有类图 3.1.6.1.7.1.1.类图类图 3.1.6.1.7.1.2.变量变量 主要的变量 3.1.6.1.7.1.3.方法方法 方法的入参、返回值，方法实现算法 3.1.6.1.7.1.4.事件事件/代理代理 事件/代理的入参、返回值，方法实现算法 xx 系统 北京中软国际信息技术有限公司 第 5 页 4. 中间件程序中间件程序 1 设计说明设计说明 逐个给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对 于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它 所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点 即可。 4.1.程序描述程序描述 给出对该程序的简要描述，主要说明安排设计本程序的目的、特点 4.2.功能功能 说明该程序应具有的功能，可采用IPO图的形式 4.3.数据结构数据结构 所影响到的数据库的内容，影响的方式（增加、删除、更新等） 4.4.输入项输入项 给出对每一个输入项的特性（名称、标识符、数据的类型和格式、数据值的有效范围、 输入的方方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等） 4.5.输出项输出项 给出对每一个输入项的特性（名称、标识符、数据的类型和格式、数据值的有效范围、 输入的方方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等） xx 系统 北京中软国际信息技术有限公司 第 6 页 4.6.算法算法 详细说明本程序所选用的算法，具体的计算公式和计算步骤 4.7.流程逻辑流程逻辑 用图表（例如流程图、判断表等）辅以必要的说明来表示本程序的逻辑流程 4.8.接口接口 COM接口描述 4.9.异常处理思路异常处理思路 程序对异常情况的处理 4.10.类设计类设计 用Rose类图结合类伪代码实现的形式说明类的基本设计 4.11.查询条件查询条件 所用的查询条件（SQL语句）