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

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

《软件项目详细设计说明书.docx》由会员分享，可在线阅读，更多相关《软件项目详细设计说明书.docx（17页珍藏版）》请在冰豆网上搜索。

项目名称

详细设计说明书

版本号：

X.X

作者：

批准人：

日期:

XXXX年XX月XX日

XXXXXXXXXXXX公司

文档修订

版本

日期

更改人

描述（注明修改的条款或页）

抄送人：

项目经理、客户经理、客户代表、项目组成员、SCCB（在项目实际应用时最好写明抄送人的姓名）

XXXX-XX-XXX-XX

XXXX年XX月XX□

Page2of14

目录

1.引言 4

1.1编写目的 4

1.2项目背景 4

1.3定义 4

1.4参考资料 4

2.设计流程 4

3.程序系统的结构 4

3.1程序清单 4

3.2服务/事务清单 4

3.3界面清单 5

3.4代码清单 5

3.5公用函数/类清单 5

4.程序1（标识符）设计说明 6

4.1程序描述 6

4.2功能 6

4.3性能 6

4.4输人项 6

4.5输出项 6

4.6算法 6

4.7流程逻辑 6

4.8接口 6

4.9存储分配 6

4.10注释设计 7

4.11限制条件 7

4.12测试计划 7

4.13尚未解决的问题 7

5.程序2（标识符）设计说明 7

附件1服务/事务清单 8

附件2程序清单 8

附件3代码清单 9

附件4公用函数/类清单 9

附件5程序设计 10

5.1程序设计1 10

5.2程序设计2 11

附件6类设计 11

附件7 函数设计（含成员函数） 12

附件8存储过程设计 12

附件9数据结构清单 13

1.引言

1.1编写目的

《阐明编写详细设计说明书的目的，指明读者对象。

》

1.2项目背景

《应包括项目的来源和主管部门等。

》

1.3定义

《列出文档中所用到的专门术语的定义和缩写词的原文。

》

1.4参考资料

《列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括:

a.需求规格说明书；

b.概要设计说明书；

c.文档中所引用的其他资料、软件开发标准或规范。

》

2.设计流程

《如给出软件系统的流程结构图。

》

3.程序系统的结构

3.1程序清单

《程序清单列出所有最终运行程序》

《格式见附2》

《台头要描述清楚，其中编号见“命名规范”》

《各栏的填写方法如下：

编号：

从1开始的递增序列，保证同一程序清单内没有重复

程序名称：

见“命名规范”，是最终实现的程序名称，并且应该与概要设计中的模块编号基本一致。

程序说明：

简要介绍该程序的功能

文件清单：

列出实现该程序的文件清单，包括重要的头文件、源码文件、库文件、必须的目标文件等。

》

3.2服务/事务清单

《服务清单列出主机系统提供的所有事务、各节点所有的服务》

《格式见附1》

《各项目小组列出本组所有的服务清单后，统一按节点生成服务清单。

》

《各栏的填写方法如下：

编号：

项目组统一编制

服务名称：

见“命名规范”

所属系统：

为HVPS、BEPS、SAPS、CCMS、PDMS、TRCS、公共服务、接口服务之一

相关程序：

列出提供该服务的程序名（或清单）

服务说明：

简要介绍该服务》

3.3界面清单

《格式及编制说明见“概要设计规范”》

3.4代码清单

《代码清单列出所有源码文件》

《格式见附3》

《台头要描述清楚，其中编号见“命名规范”》

《各栏的填写方法如下：

编号：

从1开始的递增序列，保证同一代码清单内没有重复

源程序名称：

见“命名规范”，是最终实现的文件名称，包括文件后缀，并且应该与概要设计中的模块编号基本一致。

程序说明：

简要介绍该程序的功能，并列出文件包括的公用函数。

》

3.5公用函数/类清单

《公用函数/类清单列出所有的公用函数、公用类》

《格式见附4》

《台头要描述清楚，其中编号见“命名规范”》

《各栏的填写方法如下：

编号：

从1开始的递增序列，保证同一清单内没有重复

名称：

公用函数名或公用类名。

说明：

简要介绍函数的功能，或者类的用途。

》

4.程序1（标识符）设计说明

《从本章开始，逐个地给出各个层次中的每个程序的设计考虑。

以下给出的提纲是针对一般情况的。

对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。

》

4.1程序描述

《给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如是常驻内存还是非常驻？

是否子程序？

是可重入的还是不可重入的？

有无覆盖要求？

是顺序处理还是并发处理等）。

》

4.2功能

《说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。

》

4.3性能

《说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。

》

4.4输人项

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

》

4.5输出项

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

》

4.6算法

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

》

4.7流程逻辑

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

》

4.8接口

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

》

4.9存储分配

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

》

4.10注释设计

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

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

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

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

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

可根据实际情况进行填写。

》

4.11限制条件

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

》

4.12测试计划

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

》

4.13尚未解决的问题

《说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。

》

5.程序2（标识符）设计说明

《用类似“4”的方式，说明第2个程序乃至第N个程序的设计考虑。

》

附件1服务/事务清单

服务/事务清单

编号

节点名称

设计者

审核者

完成日期

编

号

服务名称

所属系统

相关程序

服务说明

附件2程序清单

程序清单

编号

子系统名称

节点名称

审核者

完成日期

编

号

程序名称

功能说明

实现程序的文件清单

附件3代码清单

代码清单

编号

子系统名称

节点名称

审核者

完成日期

编

号

源程序名称

程序说明

附件4公用函数/类清单

公用函数

/类清单

编号

子系统名称

节点名称

审核者

完成日期

编

名称

功能说明

编

名称

功能说明

号

号

附件5程序设计

5.1程序设计1

程序设计

名称

所属系统

预期实现的平台

设计者

审核者

完成日期

输入

输出

处理流程

XXXX年XXflXX□

Page12of

XXXX-XX-XXX-XX

14

程序设计

名称

所属系统

预期实现的平台

设计者

审核者

完成日期

5.2程序设计2

输入

输出

处理流程

附件6类设计

名称

所属系统

预期实现的平台

文件名

设计者

审核者

完成日期

类设计

定义

说明

属

性

xxxx-xx-xxx-xx

14

XXXX年XXflXX□

Page13of

成

员

函

数

依

说

附件7函数设计（含成员函数）

函数设计

名称

所属系统

预期实

现的平台

文件名

设计者

审核者

完成

日期

输入

输出

处理流程

XXXX年XXflXX□

Page14of

附件8存储过程设计

XXXX-XX-XXX-XX

14

存储过程设计

名称

所属系统

预期实现的平台

设计者

审核者

完成日期

输入

输出

处理流程

XXXX年XXflXX□

Page16of

附件9数据结构清单

数据结构清单

编号

名称

所属

系统

设计者

审核者

完成日期

编

号

数据结构定义

说明

涉及该结构的模块

XXXX-XX-XXX-XX

14

详细设计说明书

版本号：

X.X

XXXX年XX月XX日

Page17of

xxxx-xx-xxx-xx

17