软件_详细设计说明书编写规范(精)

软件详细设计说明书例一、引言在软件开发过程中，详细设计是连接概要设计和编码实现的重要环节。

它为软件的编码提供了具体的指导，包括模块的内部结构、算法、数据结构、接口等方面的详细描述。

本文将以一个简单的学生管理系统为例，展示一份软件详细设计说明书的范例。

二、软件概述（一）软件名称学生管理系统（二）软件功能1、学生信息管理：包括学生基本信息的录入、修改、查询和删除。

2、课程管理：课程信息的添加、修改、查询和删除。

3、成绩管理：学生成绩的录入、查询和统计分析。

三、模块设计（一）学生信息管理模块1、学生信息录入子模块输入：学生的学号、姓名、性别、出生日期、班级等信息。

处理：对输入的信息进行合法性校验，如学号的唯一性检查、出生日期的格式检查等。

将合法的信息保存到数据库中。

输出：提示信息，如“录入成功”或“录入失败，请重新输入”。

2、学生信息修改子模块输入：要修改的学生学号和修改后的信息。

处理：根据学号查询出对应的学生信息，将修改后的信息更新到数据库中。

输出：提示信息，如“修改成功”或“修改失败，请重新输入”。

3、学生信息查询子模块输入：查询条件，如学号、姓名、班级等。

处理：根据查询条件从数据库中检索出符合条件的学生信息。

输出：查询结果，以列表形式展示学生的基本信息。

4、学生信息删除子模块输入：要删除的学生学号。

处理：根据学号从数据库中删除对应的学生信息。

输出：提示信息，如“删除成功”或“删除失败，请重新输入”。

（二）课程管理模块1、课程信息添加子模块输入：课程编号、课程名称、学分、授课教师等信息。

处理：对输入的信息进行合法性校验，如课程编号的唯一性检查。

将合法的信息保存到数据库中。

输出：提示信息，如“添加成功”或“添加失败，请重新输入”。

2、课程信息修改子模块输入：要修改的课程编号和修改后的信息。

处理：根据课程编号查询出对应的课程信息，将修改后的信息更新到数据库中。

输出：提示信息，如“修改成功”或“修改失败，请重新输入”。

软件详细设计说明书1 引言1.1 编写目的提示：说明编写这份详细设计说明书的目的，指出预期的读者范围。

1.2 背景提示：应具体说明以下基本内容：①待开发的软件系统的名称；②列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。

1.3 定义提示：列出本文件中用到的专门术语的定义和缩写词的原词组。

1.4 参考资料提示：列出要用到的参考资料，如：①本项目的经核准的计划任务书或合同、上级机关的批文；②属于本项目的其他已发表的文件；③本文件中各处引用的文件、资料，包括所要用到的软件开发标准。

列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

2 程序系统的结构提示：用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。

3 程序1（标识符）设计说明提示：从本章开始，逐个地给出各个层次中的每个程序的设计考虑。

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

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

3.1 程序描述提示：给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如是常驻内存还是非常驻？是否子程序？是可重入的还是不可重入的？有无覆盖要求？是顺序处理还是并发处理？．．．．．等）。

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

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

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

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

软件开发文档文档名称：详细设计说明书项U 名称：XXXXXXXXXX 项口负责人：XX XXXxxxx信息科技有限公司2004 年添加，修改，删除）LI录1 导言11.1目的 11.2范围 11.3术语定义 1 1.4参考资料 1 1.5相关文档 1 1.6版本更新记录12模块实现设讣12. 1公用模块设计12.2专用模块设计12. 3存储过程设计12.4触发器设计13接口实现设计14其他实现设计14. 1角色授权设讣14.2其他详细设计15详细设汁检查列表15. 1功能设汁检查列表15.2性能设汁检査列表15. 3接口设汁检查列表1本章对该文档的LI的、功能范圉、术语、1导言行说明。

1.1目的本文档的U旨在推动软件工程的规范化，使设计•人员遵循统一的详细设汁书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设讣资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。

详细设计的详细程度，应达到可以编写程序的程度。

1.2范围本文档用于软件设汁阶段的详细设计，它的上游（依据的基线）是《概要设计说明书》，它的下游是源程序清单及单元测试计划，并为单元测试报告提供测试依据。

该范圉应覆盖《概要设计说明书》中的功能点列表、性能点列表、接口列表。

软件详细设计•的范围是：各子系统的公用模块实现设讣、专用模块实现设计、存储过程实现设讣、触发器实现设讣、外部接口实现设计、部门角色授权设计、其他详细设计等。

按照3层结构（B/A/S）的布局，详细设计应从下面3个方面进行。

数据库服务器上的面向数据的设讣：数据字典物理设计、基本表物理设计、中间表物理设计（报表设计）、临时表物理设讣、视图物理设计、存储过程物理设讣、触发器物理设讣。

应用服务器上的面向业务逻辑的设计：接口数据设讣、中间件设讣、数据通信传输设计、可视构件设计、非可视构件设计、角色授权设计、功能点设计（功能点列表设计）。

浏览器上的面向对象的设讣：录入修改界面设计、浏览查询界面设计、登录注册界面设计、信息发布界面设计。

五、详细设计说明书五、详细设计说明书1．引言 (1)1.1编写目的 (1)1.2项目背景 (1)1.3定义 (2)1.4参考资料 (2)2．总体设计 (2)2.1需求概述 (2)2.2软件结构 (2)3．程序描述 (2)3.1功能 (3)3.2性能 (3)3.3输入项目 (3)3.4输出项目 (3)3.5算法 (3)3.6程序逻辑 (3)3.7接口 (3)3.8存储分配 (3)3.9限制条件 (3)3.10测试要点 (3)1．引言1.1编写目的【阐明编写详细设计说明书的目的，指明读者对象。

】1.2项目背景【应包括项目的来源和主管部门等。

】五、详细设计说明书1.3定义【列出文档中所用到的专门术语的定义和缩写词的原文。

】1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划任务书、合同或批文；b.项目开发计划；c.需求规格说明书；d.概要设计说明书；e.测试计划（初稿）；f. 用户操作手册（初稿）；g.文档中所引用的其他资料、软件开发标准或规范。

】2．总体设计2.1需求概述2.2软件结构【如给出软件系统的结构图。

】3．程序描述【逐个模块给出以下的说明：】五、详细设计说明书3.1功能3.2性能3.3输入项目3.4输出项目3.5算法【模块所选用的算法。

】3.6程序逻辑【详细描述模块实现的算法，可采用：a.标准流程图；b.PDL 语言；c.N－S图；d.PA D；e.判定表等描述算法的图表。

】3.7接口3.8存储分配3.9限制条件3.10测试要点【给出测试模块的主要测试要求。

】。