系统详细设计项目说明指导书模板.doc

XXXXXXXXXXXXXXXXXXX项目名称具体设计说明书XXX企业二XX年X月文档修改统计版本号版本描述责任人日期备注V1.0初始编制XXXX-8-31版本号示例：V1.0、V2.0、V3.0、V4.0、V5.0目 录第一章引言41.1目标41.2背景41.3术语定义41.4参考资料4第二章系统概述6第三章程序1设计说明73.1程序描述73.1.1模块架构图73.1.2功效73.1.3类图73.1.4增加功效（功效点）83.1.5程序步骤93.1.6测试和限制条件93.1.7备注9第四章程序2设计说明10第五章公用接口程序说明115.1全局变量115.2公用界面或接口115.3公用方法和过程11第六章附件12具体设计评审意见13第一章 引言1.1 目标提醒：简明说明编写这份具体设计说明书目标，指出预期读者。本具体设计说明书适用读者为：软件开发者、测试人员1.2 背景 1.3 术语定义序号术语名称术语定义1234.1.4 参考资料提醒：列出所本文档所使用参考资料，包含：A 本软件开发所经核准协议或标书或可行性汇报等文档B 软件开发计划书C 需求分析汇报D 测试方案（若存在初稿话）E 概要设计说明书F 和本项目相关已发表文件或资料G 本文件中各处引用文件、资料，所采取软件开发标准和规范注意：必需列出文件、资料作者、标题、编号、发表日期和出版单位，以说明这些文件资料起源。若一些文档有保密要求，则要说明其保密等级。序号文档名称作者版本/日期123第二章 系统概述画出系统体系结构图，以说明系统体系结构实现技术，所用到数据库主体描述、怎样实现访问数据库、怎样划分程序主体部分。能够采取MVC模式表述、也能够采取UML中系统设计关键是基于MVC设计模式，M代表模型Model，V代表视图 View， C代表控制器Controller。MVC模式将系统分为三层，层和层之间经过又一定模式联络，使数据实体和业务逻辑、业务逻辑和页面展现分离。MVC模式图举例以下图：图二-1 MVC模式图第三章 程序1设计说明提醒：从本章开始，逐步将各模块功效和设计思想、内容等进行逐层解剖分析3.1 程序描述提醒：给出对该程序简明描述，关键说明安排设计本程序目标意义，而且，还要说明本程序特点。3.1.1 模块架构图提醒：给出模块代码结构，如经典三层结构，能够用UML组件图表示。3.1.2 功效提醒：简明进行功效描述，可采取IPO（即输入-处理-输出图）表示。3.1.3 类图提醒：用UML类图利用面向对象思想设计模块代码实现，用类图表示出完整类结构，包含类名，属性，关键方法名称，方法参数，关键方法或算法能够用标注方法，用伪码表示出来。类图中要表示出类和类之间关系，隶属关系、调用关系等。UML类图举例以下：图三-1 类图注意，关键方法要做具体说明，举例以下：说明：1. BaseAbsDao：a) getAll():返回全部信息列表。b) getById(string id):依据id检索，并返回特定对象。2. BaseBean：3.1.4 增加功效（功效点）提醒：简明进行功效描述，可采取IPO（即输入-处理-输出图）表示。3.1.4.1 功效描述增加机构管理信息。3.1.4.2 输入和界面设计提醒：图、表方法清楚描述每一个输入项特征，包含名称、标识、数据类型和格式、数据值有效范围、输入方法。数量和频度、输入媒体、输入数据起源和安全保密条件等3.1.4.3 类和接口设计提醒：列出本模块和其它模块接口关系或要求列明全部接口，包含接口名称，调用方法，接口参数结构等。1. 接口：接口名称：接口方法：输入参数： 返回信息：2. 数据接口：3. 其它接口：3.1.5 程序步骤提醒：以步骤图或次序图形式给出本程序模块流转关系。包含一下参数：输入参数：处理过程：包含数据结构：返回结果：其它参数：3.1.6 测试和限制条件提醒：给出具体设计中考虑测试程序测试点和状态、参数等，和对系统在程序运行、测试时需要做出多种限制等。3.1.7 备注第四章 程序2设计说明提醒：和上一章类似，若有N个，则需要分开N项描述。第五章 公用接口程序说明提醒：给出各类公用接口程序设计考虑，如全局变量、数据字典、公用界面、公用方法和过程等。5.1 全局变量提醒：罗列各个全局变量属性要求，包含全局变量名称、说明、数据类型、长度、取值范围等信息名称说明数据类型长度取值范围5.2 公用界面或接口提醒：要求描述清楚公用界面界面布局情况，和界面上所包含到多种数据项相关属性，和界面相关具体处理说明（有逻辑算法和计算公式，则要具体说明）、输入和输出数据要求等等，要求要附有界面书面格式，可具体注明参见某个图表或某个相关附件5.3 公用方法和过程提醒：介绍公用方法和过程所实现关键功效，说明公用方法和过程所需调用输入参数、输出参数和逻辑处理和相关算法描述，并注明该公用方法和过程适用范围。能够使用表格形式表述。第六章 附件提醒：罗列和本具体设计汇报相关文档资料，可包含以下内容：1. 数据库设计相关文档资料，如：数据字典2. 用户界面相关约定、相关报表或模板格式、多种常规底稿模板等3. 编程语言程序设计规范4. 其它相关资料具体设计评审意见项目名称： 致：（建设单位）抄送：（监理单位）我方依据协议相关要求完成了项目 具体设计说明书编制，并经项目经理审查同意，请给予审查。承建单位（盖章）项目经理（签字）： 日 期： 年 月 日监理单位意见：总/专业监理工程师（签字）： 日 期： 年 月 日建设单位意见：项目代表（签字）： 日 期： 年 月 日一式三份，签字单位各持一份存档。