软件项目详细设计说明书模板.docx

软件项目

详细设计说明书模板

引言

编写目的

说明编制的目的是，大体上介绍一下软件系统中各层次中模块或子程序、以及数据库系统的设计考虑，表明此文档是主要是为编码人员提供服务，并且其他类型的项目参与人员也可以通过此文档对软件/项目有更深入了解。

编写详细设计说明书的目的是为了使开发人员在完成概要设计说明书的基础上，完成概要设计的各项功能规定；为程序员写出实际的程序代码提供依据。它是软件设计阶段所有任务和所有相关人员所需的参考资料。

项目背景

说明此软件或系统的项目背景、需求背景、开发目的等，还可以列出参与人员等相关信息。

包括系统的名称，项目组名称，使用单位、使用对象等基本信息。

软件系统名称：智慧政务APP

软件开发平台：JAVA开发平台

参考资料

列出有关资料的作者、标题、编号、发表日期、出版单位，说明能够得到这些文件资料的来源，可包括:

《项目技术文件》

《项目招标文件》

《项目实施方案》

《软件需求规格说明书》

《项目设计方案》

《软件项目概要设计说明书》

《数据库设计文档》

术语说明

列出文档中用到的和开发有关，或与行业、业务、需求有关的专业术语，并进行解释。

设计概述

需求概述

说明本项目的需求，一般在《软件规格说明书》里面会有详细的说明，可以参考部分内容（不能全部照搬）。

运行环境概述

描述本项目系统运行的环境。

硬件要求；

软件要求；

运行系统；

操作系统；

数据库。

条件与限制

详细描述本项目系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。

详细设计方法和工具

系统使用统一建模工具EnterpriseArchitect，并使用面向对象分析（00A）对系统业务需求进行分析。

系统功能概述

描述关于此项目系统功能的概述，用图表等形式，构成系统功能总图。

用户介绍

说明本系统的用户对象。

该平台用户分为：领导、各部门、企业单位及社会公众。

层次

用户分类

领导

区领导

信息资源管理员

系统管理员

各局委办

信息资源管理员

业务系统开发人员

企业单位及社会公众

信息资源管理员

业务系统开发人员

总体功能

描述下系统的总体实现的功能情况。

功能模块划分

说明本系统的功能模块划分情况：

模块1

子功能1

子功能2

子功能3

模块2

子功能1

子功能2

模块3

子功能1

子功能2

……

……

系统模块设计

模块1

功能描述

对该功能的说明和描述，是读者了解这个模块的作用和意义。

功能设计

说明该功能的设计思路和设计流程。

功能特点

【功能描述：说明该程序应具有的功能，功能结构图，原型界面，可采用IPO图（即输入一处理一输出图），类图，用例图等。】

1、输入项

【给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。】

2、输出项

【给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。】

3、算法

【详细说明本程序所选用的算法，具体的计算公式和计算步骤。】

4、逻辑流程

【用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。】

5、接口

【用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构。】

6、存储分配

【根据需要，说明本程序的存储分配。】

7、注释设计

【说明准备在本程序中安排的注释，如：

a．加在模块首部的注释；

b．加在各分枝点处的注释；

c．对各变量的功能、范围、缺省条件等所加的注释；

d．对使用的逻辑所加的注释等等。】

8、限制条件

【说明本程序运行中所受到的限制条件】

9、测试计划

【说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定】

模块2

功能描述

对该功能的说明和描述，是读者了解这个模块的作用和意义。

功能设计

说明该功能的设计思路和设计流程。

功能特点

……

模块1

功能描述

对该功能的说明和描述，是读者了解这个模块的作用和意义。

功能设计

说明该功能的设计思路和设计流程。

功能特点

……