系统详细设计书模板.docx

系统详细设计书模板.docx

《系统详细设计书模板.docx》由会员分享，可在线阅读，更多相关《系统详细设计书模板.docx（8页珍藏版）》请在冰豆网上搜索。

系统详细设计书模板

密级：

●绝密○机密○普通

项目名称

系统详细设计说明书

（版本号：

）

文档编号：

项目名称：

编写人：

编写日期：

审核人：

审核日期：

XXX公司

版本更新摘要

版本号

日期

修改人

更新摘要

第一章

引言

一.1文档目的

《系统详细设计书》是项目组的内部文档，是开发经理和开发人员在《系统逻辑设计书》的基础上，从系统的逻辑对象、数据实体和界面逻辑关系中进一步整理和细化得到的设计方案。

《系统详细设计书》将确定系统采用的技术方案，平台，并明确实际开发的组件、数据库表、窗口以及页面等。

详细设计是把现实的技术应用到逻辑模型上，并考虑到实现的可能性和最终系统的性能。

《系统逻辑设计书》的最终结果包含组件定义、特定平台上的用户界面设计，以及数据库的设计。

《系统逻辑设计书》会说明系统的核心的算法，但具体每个模块的实现算法可以在模块的《开发文档》中说明。

《系统逻辑设计书》的主要读者是项目组成员。

是开发经理制定《开发计划》、测试管理制定《测试计划》、实施人员制定《实施计划》的基础。

一.2参考资料

说明编写《系统详细设计书》中参考的资料。

其中必然包含的是《系统逻辑设计书》。

第二章

目标范围

在每个重要文档前面强调项目的目标和范围有利于保证项目执行过程中不发生偏差。

项目的目标范围在《项目建议书》中已经有明确的定义，在《系统逻辑设计书》中也重复强调，这里可以根据项目进展做少量的修订。

这部分内容应该基本同前面阶段的文档。

二.1业务目标

从客户角度来看系统，说明系统实施后要能帮助客户解决哪些问题，使客户达到的什么目标。

也要明确说明不解决的问题。

这部分内容可以在《系统逻辑设计书》的基础上做少量修正。

二.2项目目标

说明在当前阶段最终我们要达到的项目目标。

这部分内容可以在《系统逻辑设计书》的基础上做少量修正。

二.3设计目标

说明系统设计要达到的指标。

综合并量化《需求分析报告》中第五章“系统规格”中的指标。

第三章

系统结构

三.1设计原则

说明进行技术选型和实现方式时所遵循的原则。

包括用户环境的限制、客户的要求、技术方面的考虑等等。

三.2系统框架

说明系统的层次结构，以及这些层次之间的关系。

三.3功能模块

系统总体的模块和功能组划分，这部分侧重每个模块和功能组的功能说明和接口。

三.4部署结构

说明系统各个部署组成，说明每个层次所在的位置以及这些组成部分之间的联系。

如果系统牵涉到其它外部系统，需要首先说明在用户方外部系统的部署结构。

然后再说明开发系统的部署结构，验证系统的部署能满足用户整体系统部署环境下的要求。

表示部署结构可以采用“网络、组件、数据拓扑图”的方式，在Visio中通过“企业应用”模板生成，例如：

三.5系统环境

说明最终系统实现的平台、工具以及软硬件环境。

第四章

系统组件

四.1组件规格

说明每一个业务组件以及所提供的服务的接口。

需要包括：

●类型：

声明组件属于的类型，比如，是.dll,是ActiveXdll,是资源文件（.bas,.js…），是exe,是OCX,是.lib等等。

●交互标准：

描述组件之间采用何种交互标准（COM,DCOM…）。

●属性的访问：

简要说明每一种属性的访问类型：

只读，读/写。

●属性的物理类型：

简要说明每一种属性的物理类型：

整型，长整型，布尔型，字符串型等等。

●接口：

组件接口制定了组件之间的调用和被调用关系。

它用于访问到接口之下的服务，并且它可以表示一个或多个服务。

一个发布的接口应当被视为接口规范，保持不变。

修改已有的接口应当发布为一个新的版本或作为一个完全新的接口。

●每个接口提供的服务：

类出服务的名称，然后给出具体的描述。

●前提条件：

声明在执行一个操作之间的前提准备条件。

前提条件意味着调用者必须进行的检查工作。

●结果：

声明操作执行之后环境情况如何。

●不变性：

不变性是指对一个类的所有实例均不变的数据，如C++类中的静态数据成员。

●依赖条件：

与其他服务的依赖条件（组件内部或外部组件），按事件的执行顺序或其他标准。

四.2组件关系

说明组件之间存在的消息传递或者调用关系。

组件关系的描述可以利用Visio的“COM和OLE”模板描述。

例如：

四.3

组件模块

针对功能模块，说明每个功能模块中包含的组件，并说明组件的打包发布方式。

可以利用Visio的“企业应用”模板生成组件的分布图。

第五章系统数据

五.1数据字典

针对数据库中的每个表和视图，说明表/视图的名称、字段名、类型、长度、意义等信息：

名称

字段名

类型

长度

说明

主键

索引

备注

触发器

五.2数据结构/文件

说明系统核心数据结构，包括输入输出文件的格式。

第六章

系统界面

六.1界面结构

详细描述每个界面的功能、和基本的界面布局。

针对每个窗口/页面，说明此界面模块的功能。

并对界面模块中的所有用户界面元素（按钮、输入行、文本等）进行说明，包括数据类型、格式、合法的数值和业务校验规则。

可以采用Visio中的“Windows用户界面”模板来描述：

六.2界面关系

细化《系统逻辑设计书》中的界面关系部分。

使得界面关系满足组件分布和配置环境。

这里的界面关系应该基本同《系统逻辑设计书》：

六.3数据和组件关联

描述用户界面怎样与数据和组件关联。

由于组件、数据库和界面三个方面的设计共同协作，才形成一个整体的设计方案。

因此，三个设计结果必须相互影响。

本节的目的是以界面为纽带，准确描述出组件、数据和界面是怎样相互影响的。

这里不需要描述技术细节，只要描述出界面元素是哪些数据字段绑定的，哪个按钮是调用哪个服务。

第七章

外部接口

七.1输出接口

定义和外部系统的输出接口。

包括输出接口的参数设置、数据结构、调用方法等信息。

七.2输入接口

定义从外部系统获得数据的输入接口。

包括输入接口的参数设置、数据结构、调用方法等信息。

第八章其他设计

针对系统其它设计目标的设计方案。

可以包括如下一些部分：

●安全性

●系统备份和恢复

●系统维护