软件详细设计说明
title: 软件详细设计说明 date: 2021-01-26 tags: [详细设计, 软件设计]
categories: [软件设计]
::: {.center} xx公司
2020-01-01 :::
文档管理
合理地管理主文档, 确保文档版本的及时更新,同时保持备份文档和源文档的一致性。
版本管理
本版本修订日期 2019-08-12 生效日期 2019-08-12
版本 生效日期 变更内容 编制人
V1.0 2020-01-01 初稿编写完成 xx
引言
编写目的
说明编写这份详细设计说明书的目的,指出预期的读者范围。
背景
说明:
待开发的软件系统的名称;
列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。
术语和缩略语
列出本文件中用到的专门术语的定义和缩写词的原词组。
参考资料
列出要用到的参考资料,如:
本项目的经核准的计划任务书或合同、上级机关的批文;
属于本项目的其他已发表的文件,包括软件需求说明书、软件概要设计说明等;
本文件中各处引用的文件、资料,包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。
系统结构
以表格方式列出本程序系统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间的层次结构关系。并用文字说明每个程序完成的功能,以及互相之间的调用关系。
程序1(标识符)设计说明
从本章开始,逐个地给出各个层次中的每个程序的详细设计。以下给出的提纲是针对一般情况的。对于一个具体的模块,可能根据需要在其说明条目上有适当增减。
程序描述
给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且说明本程序的特点。
功能
说明该程序应具有的功能,可采用IPO图(即输入-处理-输出图)的形式。
性能
说明对该程序的全部性能要求,包括对精度、灵活性和时间特性的要求。
输入项
给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
输出项
给出对每一个输出项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输出的形式、数量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等等。
算法
详细说明本程序所选用的算法,具体的计算公式和计算步骤。
流程逻辑
用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。
接口
用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构。
限制条件
说明本程序运行中所受到的限制条件。
单元测试
说明对本程序进行单元测试的计划和方式,包括单元测试用例的设计等。
尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
程序2(标识符)设计说明
......
内容审核要点:
本文档内容与概要设计说明、软件需求规格说明等文档中的内容是否一致性;
所述内容是否完备;
各子程序模块描述是否清楚;
是否有必要的单元测试用例编制方面的考虑;
程序模块间关系是否清楚准确。
参考