软件详细设计文档模板最全面详细设计文档.docx

软件详细设计文档模板最全面详细设计文档.docx

《软件详细设计文档模板最全面详细设计文档.docx》由会员分享，可在线阅读，更多相关《软件详细设计文档模板最全面详细设计文档.docx（15页珍藏版）》请在冰点文库上搜索。

软件详细设计文档模板最全面详细设计文档

创作编号：

BG7531400019813488897SX创作者

研发生产中心

文档编号

版本

A1

密级

商密A

项目名称

Xx系统

项目来源

Xxx系统

详细设计说明书

编

（内部资料请勿外传）

写：

日期:

检

査：

日期:

审

核：

日期:

批

准：

日期:

XX公司

版权所有不得复制

文档变更记录

作编号：

BG753一1400019813488897S

X

作者：

别如—IE

序号

变更（+/-）说明

作者

版本号

日期

批准

1

2

创作编号：

BG7531400019813488897SX创作者

1.引言5

1.1编写目的和范围5

1.2术语表5

1.3参考资料5

1.4使用的文字处理和绘图工具5

2.全局数据结构说明8

2.1常量8

2.2变量8

2.3数据结构8

3.模块设计10

3.1用例图10

3.2功能设计说明11

3.2.1模块111

3.2.2模块212

4.接口设计13

4.1内部接「I13

4.2外部接「I13

4.2.1接口说明13

4.2.2调用方式13

5.数据库设计13

6.系统安全保密设计13

6.1说明13

6.2设计13

6.2.1数据传输部分13

6.2.2IP过滤分部14

6.2.3身份验证部分14

7.系统性能设计14

8.系统出错处理14

1.引言

1.1背景

此文档的背景

1.2编写目的和范围

说明写这份详细设计说明书的目的。

本详细设计说明书编写的目的是说明程序模块的设计考虑,包扌舌程序描述、输入/输出、算法和流程逻辑等,为软件编程和系统维护提供基础。

本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。

1.3术语表

定义系统或产品中涉及的重要术语,为读者在阅读文档时提供必要的参考信息。

序号

术语删略语

说明性定义

1

PM

ProjectManager,项目经理

2

1.4参考资料

列出有关资料的名称、作考、文件编号或版本等。

参考资料包括•:

a.需求说明书、架构设计说明书等;

b.本项目的其他己发表的文件;

c.引用文件、资料、软件开发标准等。

资料名称

作者

文件编号、版本

资料存放地点

1.5使用的文字处理和绘图工具

创作编号：

BG7531400019813488897SX创作者

文字处理软件:

[编写设计文档使用的文字处理软件,如RedOffice]绘图工具:

[使用的UML工具,如Rose、Jude、Visio]

2.设计概述

2.1任务和目标

2.1.1需求概述

2.1.2运行环境概述

2.1.3条件与限制

2.1.4详细设计方法和工具

3.系统详细需求分析

主要对系统级的需求进行分析。

首先应对需求分析提出的企业需求进一步确认,并对由于情况变化而带来的需求变化进行较为详细的分析。

3.1详细需求分析

3.1.1详细功能需求分析

3.1.2详细性能需求分析

3.1.3详细资源需求分析

3.1.4详细接口需求分析

3.1.5详细系统运行环境及限制条件分析

4.总体方案确认

着重解决系统总体结构确认及界面划分问题。

4.1系统总体结构确认

对系统组成、逻辑结构及层次进行确认,对应用系统、支撑系统及各自实现的功能进行确认,细化集成设计及系统工作流程,特别要注意因软件的引进造成的系统本身结构和公司其他系统的结构变化。

包扌舌:

4.1.1系统组成、逻辑结构及层次确认

4.1.2应用系统结构确认

4.1.3支撑系统结构确认

4.1.4系统集成确认

4.1.5系统工作流程确认

4.2系统详细界面划分

4.2.1应用系统与支撑系统的详细界面划分

应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范n及访问方式,网络及数据库对应用系统的支撑方式,全局数据的管理与存取方式等。

4.2.2系统内部详细界面划分

系统各功能之间的界面包括覆盖范锵,模块间功能调用涉及到的系统模块及方法,全局数据格式，系统性能要求等。

5.全局数据结构说明

本章说明本程序系统中使用的全局数据常量、变量和数据结构。

5.1常量

包括数据文件名称及其所在目录,功能说明,具体常量说明等。

5.2变量

本章说明本程序系统中使用的全局数据常量、变量和数据结构。

5.3数据结构

包括数据结构名称,功能说明,具体数据结构说明（定义、注释、取值）等。

6.4.2内部界面设计

设计系统内部各功能模块间的调用关系和数据接I/。

6.4.3用户界面设计

规定人机界面的内容、界面风格、调用方式等,包括所谓的表单设计、报表设计和用户需要的打印输出等设计。

此部分内容可能比较多。

7.开发和测试生产环境说明

7.1开发环境

7.2测试及产品环境

-Developmentevni「onment:

programminglanuague,database

Vs2010-svn-iss6.1+-mysql/sqlserver2005/2008-.netframwork4.0

-Testing&productionenvironment:

OS,database-.netframwork4.0

Windwos2003,iis6.0,MySQL,

&模块设计

8.1用例图

8.2

创作编号：

BG7531400019813488897SX创作者:

别如克★

8.3功能设计说明

8.3.1模块1

模块1主要分为以下几个子模块:

子模块1、子模块2和子模块N。

8.3.1.1子模块1

8.3.1.1.1设计图

8.3.1.1.2功能描述

简要描述子模块1的业务功能。

8.3.1.1.3输入数据

详细描述用户输入的数据（包括任何输入设备）以及这些数据的有效性检验规则。

详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。

831.1.4输出数据

详细描述子功能1所产生的数据以及这些数据的表现形式。

8.3.1.1.5业务算法和流程

从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。

8.3.1.1.6数据设计

给出本程序中的局部数据结构说明,包扌舌数据结构名称,功能说明,具体数据结构说明（定义、注释设计、取值）等。

相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。

）

8.3.1.1.7源程序文件说明

给出本程序的各源程序文件的说明,包括源程序文件名称及其所在目录,功能说明,包含的前导文件及函数名称等。

8.3.1.1.8函数说明

具体说明本程序中的各个函数,包括函数名称及其所在文件,功能，格式，参数,全局变量,局部变量,返回值,算法说明,使用约束等。

8.3.1.1.9限制条件

8.3.1.1.10其他说明

8.3.2模块2

模块［主要分为以下几个子模块:

子模块1、子模块2和子模块N。

8.3.2.1子模块1

8.3.2.1.1设计图

832.1.2功能描述

简要描述子模块1的业务功能。

832.1.3输入数据

详细描述用户输入的数据（包拾任何输入设备）以及这些数据的有效性检验规则。

详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。

8.321.4输出数据

详细描述子功能1所产生的数据以及这些数据的表现形式。

8.3.2.1.5业务算法和流程

从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。

832.1.6数据设计

给出本程序中的局部数据结构说明,包扌舌数据结构名称,功能说明,具体数据结构说明（定义、注释设计、取值）等。

相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。

）

8.3.2.1.7源程序文件说明

给出本程序的各源程序文件的说明,包括源程序文件名称及其所在目录,功能说明,包含的前导文件及函数名称等。

8.3.2.1.8函数说明

具体说明本程序中的各个函数,包拾函数名称及其所在文件,功能，格式，参数,全局变量,局部变量,返回值,算法说明,使用约束等。

8.3.2.1.9限制条件

8.3.2.1.10其他说明

9.接口设计

9.1内部接口

9.2外部接口

9.2.1接口说明

例如：

XX子系统通过XX从XX子系统取得XX等,相关标准,调用示例,可根据需要增加章节描述接口。

9.2.2调用方式

例如:

内部接II调用:

例:

/**

*通过用户服务号码取得该客户认证密码等信息,如果该客户存在返回为0,其他情况参考错误编码

*/

publicRUserlnfogetUserlnfo（StringuserNo）;

10.数据库设计

详见〔XXX数据库设计说明书］

如果数据库设计内容比较少,则直接在此处描述。

11.系统安全保密设计

11.1说明

例如:

由于存在与外部系统的接所以需要考虑访问安全的问题.

11.2设计

例如:

分为数据传输部分,ip过滤部分,身份验证部分•［章节可补充］

11.2.1数据传输部分

例如:

在部分数据传递的时候,考虑以https协议,需要在部署的时候作相关处理.

11.2.2IP过滤分部

例如:

可在系统前端通过Filter实现,该Filter实现对该地址访问的IP过滤作用.可信任IP地址通过xml文件进行配置.

11.2.3身份验证部分

例如：

对信任的用户,颁发身份验证码,通过该标识进行身份识别.

12.系统性能设计

13.系统出错处理

例如:

为了在系统出现异常情况卜-给用户以明确的提示,可采用两种方式予以提示:

1.使用Javascript的alert（）函数直接提示,这主要在输入或修改的情况下使用;

2.使用统一的错误界面提示,该界面对应于errorpage.jsp页面。

错误界面样式如下图所示:

错误提示：

“错误提示内容”

错误提示界面

14.设计和开发规范

I可以列表方式列出设计开发的参考文档的索引,内容较少/关犍内容可以章节

14.1数据库设计规范

【参见《XXXX数据库轴规范汎

14.2.NET编码规范

特别强调:

◊详细请参见《ASP.Net文档规范》

◊这里只做简单阐述，如有变动,会及时同事整个项目组相关人员。

（1）不要给类名加前缀。

使用PascalCasing风格,不使用匈牙利命名法。

（2）要用名词词组来给类型命名。

使用PascalCasing风格。

（3）类名少用缩写，不要使用下划线字符Uo

（4）基类CBase的文件名为：

FileBase.cs;

（5）泛型类命名：

考虑用T来命名参数类型，类如：

publicclassListo

（6）接口（Interface）命名规范和类命名规范相同，唯一区别是接口在名字前加上"I"前缀。

（7）枚举命名：

以复数结尾，表明这是一个枚举,例如：

Enum

ColorButtons

（8）结构命名：

表明这是一个结构体,例如：

StructureCustomerlnfoRecord以Record结尾

◊除使用工具直接生成的类夕卜,其它所有类的功能要有注释,即使只是一个数据对象；非常见功能的API必须要有功能描述的注释。

独立的要被应用其他功能所调用的模块的接口和公共API的注释要完备，即包括功能说明、参数

和返回值说明。

其它情况的API的注释尽量完备，但不强制要求。

◊—次性的流打开后必须关闭和釋放。

一般地在流打开后，都有一个trycatch

语句,务必加上finally块释放流资源。

◊即使IF,While是单语句，也要使用"{}"来划分程序块。

◊不要有完全为调试使用的日志信息,如xxxx.info（"1"）;如要使用,在调

试完成后请及时删除。

◊—些常识性代码，不需要写没必要的注释。

◊不要用工具生成没用的注釋。

14.3代码目录结构

系统架构目录结构设计图，如下：

朋解决方案'Authority'（2个项目）

：

…雪脚本文档

刁.期Authority

田旦］Properties

|田…型弓I用

__Appjata

E）--Content

E•口Images

El•Scripts

白jquery-e^Eyui-1.2.6

l国匚jlocale

j®CJplugins

；S）|_|themes

!

・射easyloader.j

•巻jjquery-1・7\2・min・jw

jquery,eazyui.min.js

®l_Jjquefy-ui-L.8.20

（£）匚］jtKok-ui

E•匚|th^rries

田…i_IControllers

田…」D&tai

Ei_|Models

®-亡JScripts

田…i_|Views

®-©JGlobal.

jE•国壯

结构说明：

作用范围

包名

描述

整个程序Content

Images

存放图片

Scripts

Jquery以及样式表等

Scripts/jquery-easyui-1.2.6

jquery-easyui包数字为版本

Scripts/jquery-ui-1.8.20

jquery-ui包数字为版本

Scripts/jthok-ui

自定义的js格式文件

Scripts/themes

Icon格式图片以及样式

Controllers

../Controller

控制器处理来自浏览器的输入，

并返回相应页面给用户。

Data

../Data

放自定义的json文件

Models

../Models

存放模型

Scripts

・./Scripts

引入的各种外部js文件

Views

../Views

存放各种类型的试图

Global.asax

・./Global.asax

注意定义路由规则等

Web.config

../Web.config

配置文件

创作编号：

BG7531400019813488897SX

创作者：

别如克*