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

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

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

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

研发生产中间之杨若古兰创作

文档编号

版本

A1

密级

商密A

项目名称

Xx零碎

项目来源

Xxx零碎

具体设计说明书

（内部材料请勿别传）

编写：

日期：

检查：

日期：

审核：

日期：

批准：

日期：

XX公司

版权所有不得复制

文档变动记录

序号

变动（+/-）说明

作者

版本号

日期

批准

1

2

1.引言4

1.1编写目的和范围4

1.2术语表4

1.3参考材料4

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

2.全局数据结构说明5

2.1常量5

2.2变量5

2.3数据结构5

3.模块设计5

3.1用例图5

3.2功能设计说明5

3.2.1模块15

3.2.2模块26

4.接口设计7

4.1内部接口7

4.2内部接口7

4.2.1接口说明7

4.2.2调用方式8

5.数据库设计8

6.零碎平安保密设计8

6.1说明8

6.2设计8

6.2.1数据传输部分8

6.2.2IP过滤分部8

6.2.3身份验证部分8

7.零碎功能设计9

8.零碎出错处理9

1.引言

1.1布景

此文档的布景

1.2编写目的和范围

说明写这份具体设计说明书的目的.

本具体设计说明书编写的目的是说明程序模块的设计考虑，包含程序描述、输入/输出、算法和流程逻辑等，为软件编程和零碎保护提供基础.本说明书的预期读者为零碎设计人员、软件开发人员、软件测试人员和项目评审人员.

1.3术语表

定义零碎或产品中涉及的次要术语，为读者在浏览文档时提供须要的参考信息.

序号

术语或缩略语

说明性定义

1

PM

ProjectManager,项目经理

2

1.4参考材料

列出有关材料的名称、作者、文件编号或版本等.参考材料包含：

a．需求说明书、架构设计说明书等；

b．本项目的其他已发表的文件；

c．援用文件、材料、软件开发尺度等.

材料名称

作者

文件编号、版本

材料存放地点

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

文字处理软件：

[编写设计文档使用的文字处理软件，如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利用零碎与支持零碎的具体界面划分

利用零碎与支持零碎之间的界面包含零碎主服务器与其他服务器的服务范围及访问方式，收集及数据库对利用零碎的支持方式，全局数据的管理与存取方式等.

4.2.2零碎内部具体界面划分

零碎各功能之间的界面包含覆盖范围，模块间功能调用涉及到的零碎模块及方法，全局数据格式，零碎功能请求等.

5.全局数据结构说明

本章说明本程序零碎中使用的全局数据常量、变量和数据结构.

5.1常量

包含数据文件名称及其所在目录，功能说明，具体常量说明等.

5.2变量

本章说明本程序零碎中使用的全局数据常量、变量和数据结构.

5.3数据结构

包含数据结构名称，功能说明，具体数据结构说明（定义、正文、取值）等.

6.零碎具体设计

6.1功能结构图

6.2零碎结构设计及子零碎划分

对零碎的构成及逻辑结构进行设计前确认.

划分零碎功能模块或子零碎（如果有或者有须要，特别是大型的软件零碎）.

6.3零碎功能模块具体设计

按结构化设计方法，在零碎功能逐层分解的基础上，对零碎各功能模块或子零碎进行设计.此为具体设计的次要部分之一.

用条理图描述零碎的整体结构、功能分解及各个模块之间的彼此调用关系和信息交互，用IPO图或其他方法描述各模块完成的功能.以上建议采取HIPO图进行功能分解与模块描述，更高的请求建议采取IDEF0方法进行功能模型设计.

具体设计利用零碎的各个构成模块完成的功能及其彼此之间的关系，用IPO或结构图描述各模块的构成结构、算法、模块间的接口关系，和需求、功能和模块三者之间的交叉参照关系.

每个模块的描述说明可参照以下格式：

模块编号：

模块名称：

输入：

处理：

算法描述：

输出：

其中处理和算法描述部分次要采取伪码或具体的程序说话完成.

对具体设计更高的请求建议用IDEF0图进行各功能模块的设计.

如果对软件需进行二次开发（包含功能扩展、功能改造、用户界面改造等），则响应的设计工作应当设立子课题完成.

6.4零碎界面具体设计

零碎界面说明利用零碎软件的各种接口.全部零碎的其他接口（如零碎硬件接口、通讯接口等）在响应的部分说明.

6.4.1内部界面设计

根据零碎界面划分进行零碎内部界面设计，对零碎的所有内部接口（包含功能和数据接口）进行设计.

6.4.2内部界面设计

设计零碎内部各功能模块间的调用关系和数据接口.

6.4.3用户界面设计

规定人机界面的内容、界面风格、调用方式等，包含所谓的表单设计、报表设计和用户须要的打印输出等设计.此部分内容可能比较多.

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

7.1开发环境

7.2测试及产品环境

-Developmentevnironment:

programminglanuague,database

Windwos2003,iis6.0,MySQL,

8.模块设计

8.1用例图

8.2功能设计说明

8.2.1模块1

模块1次要分为以下几个子模块：

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

8.2.1.1子模块1

8.2.1.1.1设计图

8.2.1.1.2功能描述

简要描述子模块1的营业功能.

8.2.1.1.3输入数据

具体描述用户输入的数据（包含任何输入设备）和这些数据的无效性检验规则.

具体描述从物理模型中的哪些表获取数据和获取这些数据的条件.

8.2.1.1.4输出数据

具体描述子功能1所发生的数据和这些数据的表示方式.

8.2.1.1.5营业算法和流程

从营业角度具体描述根据输入数据发生输出数据的营业算法和流程.

8.2.1.1.6数据设计

给出本程序中的局部数据结构说明，包含数据结构名称，功能说明，具体数据结构说明（定义、正文设计、取值）等.相干数据库表，数据存储设计（具体说明须要以文件方式保管的数据文件名、数据存储格式、数据项及属性等.）

8.2.1.1.7源程叙文件说明

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

8.2.1.1.8函数说明

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

8.2.1.1.9限制条件

8.2.1.1.10其他说明

8.2.2模块2

模块1次要分为以下几个子模块：

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

8.2.2.1子模块1

8.2.2.1.1设计图

8.2.2.1.2功能描述

简要描述子模块1的营业功能.

8.2.2.1.3输入数据

具体描述用户输入的数据（包含任何输入设备）和这些数据的无效性检验规则.

具体描述从物理模型中的哪些表获取数据和获取这些数据的条件.

8.2.2.1.4输出数据

具体描述子功能1所发生的数据和这些数据的表示方式.

8.2.2.1.5营业算法和流程

从营业角度具体描述根据输入数据发生输出数据的营业算法和流程.

8.2.2.1.6数据设计

给出本程序中的局部数据结构说明，包含数据结构名称，功能说明，具体数据结构说明（定义、正文设计、取值）等.相干数据库表，数据存储设计（具体说明须要以文件方式保管的数据文件名、数据存储格式、数据项及属性等.）

8.2.2.1.7源程叙文件说明

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

8.2.2.1.8函数说明

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

8.2.2.1.9限制条件

8.2.2.1.10其他说明

9.接口设计

9.1内部接口

9.2内部接口

9.2.1接口说明

例如：

xx子零碎通过xx从xx子零碎取得xx等，相干尺度，调用示例，可根据须要添加章节描述接口.

9.2.2调用方式

例如：

内部接口调用：

例:

/**

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

*/

publicRUserInfogetUserInfo（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．使用统一的错误界面提示，该界面对应于页面.错误界面款式如下图所示：

错误提示界面

14.设计和开发规范

【可以列表方式列出设计开发的参考文档的索引，内容较少/关键内容可以章节方式填写】

14.1数据库设计规范

【拜见《XXXX数据库设计规范》】

14.2.NET编码规范

特别强调：

✧具体请拜见《ASP.Net文档规范》

✧这里只做简单论述，如有变动，会及时同事全部项目组相干人员.

（1）不要给类名加前缀.使用PascalCasing风格，不使用匈牙利命名法.

（2）要用名词词组来给类型命名.使用PascalCasing风格.

（3）类名少用缩写,不要使用下划线字符（_）.

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

FileBase.cs;

（5）泛型类命名：

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

publicclassList.

（6）接口（Interface）命名规范和类命名规范不异，独一区别是接口在名字前加上“I”前缀.

（7）枚举命名：

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

EnumColorButtons

（8）结构命名：

标明这是一个结构体，例如：

StructureCustomerInfoRecord'以Record结尾

✧除使用工具直接生成的类外，其它所有类的功能要有正文，即使只是一个数据对象；非罕见功能的API必必要有功能描述的正文.独立的要被利用其他功能所调用的模块的接口和公共API的正文要齐备，即包含功能说明、参数和返回值说明.其它情况的API的正文尽量齐备，但不强制请求.

✧一次性的流打开后必须关闭和释放.普通地，在流打开后，都有一个trycatch语句，务必加上finally块释放流资本.

✧即使IF，While是单语句，也要使用“{}”来划分程序块.

✧不要有完整为调试使用的日志信息，如xxxx.info（“1”）；如要使用，在调试完成后请及时删除.

✧一些常识性代码，不须要写没须要的正文.

✧不要用工具生成没用的正文.

14.3代码目录结构

零碎架构目录结构设计图,如下：

结构说明：

感化范围

包名

描述

全部程序Content

Images

存放图片

Scripts

Jquery和款式表等

jquery-easyui包数字为版本

jquery-ui包数字为版本

Scripts/jthok-ui

自定义的js格式文件

Scripts/themes

Icon格式图片和款式

Controllers

../Controller

控制器处理来自浏览器的输入，并返回响应页面给用户.

Data

../Data

放自定义的json文件

Models

../Models

存放模型

Scripts

../Scripts

引入的各种内部js文件

Views

../Views

存放各品种型的试图

留意定义路由规则等

配置文件