软件设计说明书模板

[项目名称]设计说明书[V1.0(版本号)]拟制人______________________审核人______________________批准人______________________[年月日][项目名称]——设计说明书1设计说明书1．引言1.1编写目的[说明编写这份设计说明书的目的，指出预期的读者。]1.2背景a.[待开发软件系统的名称；]b.[列出本项目的任务提出者、开发者、用户。]1.3定义[列出本文件中用到的专门术语的定义和外文首字母组词的原词组。]1.4参考资料[列出有关的参考资料。]2．总体设计2.1需求规定[说明对本系统的主要的输入输出项目、处理的功能性能要求。包括]2.1.1系统功能2.1.2系统性能2.1.2.1精度2.1.2.2时间特性要求2.1.2.4可靠性2.1.2.5灵活性2.1.3输入输出要求2.1.4数据管理能力要求2.1.5故障处理要求2.1.6其他专门要求2.2运行环境[项目名称]——设计说明书2[简要地说明对本系统的运行环境的规定。]2.2.1设备[列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能。]2.2.2支持软件[列出支持软件，包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。]2.2.3接口[说明该系统同其他系统之间的接口、数据通信协议等]2.2.4控制[说明控制该系统的运行的方法和控制信号，并说明这些控制信号的来源。]2.3基本设计概念和处理流程[说明本系统的基本设计概念和处理流程，尽量使用图表的形式。]2.4结构[给出系统结构总体框图（包括软件、硬件结构框图），说明本系统的各模块的划分，扼要说明每个系统模块的标识符和功能，分层次地给出各模块之间的控制与被控制关系。]2.5功能需求与系统模块的关系[本条用一张矩阵图说明各项功能需求的实现同各模块的分配关系。][系统模块1][系统模块2][……][系统模块m][功能需求1]√[功能需求2]√[┇][功能需求n]√√2.6人工处理过程[说明在本系统的工作过程中不得不包含的人工处理过程。]2.7尚未解决的问题[说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。]3.系统的结构[给出系统的结构框图，包括软件结构、硬件结构框图。用一系列图表列出系统内的每个模块的名称、标识符和它们之间的层次结构关系。][项目名称]——设计说明书34．模块1（标识符）设计说明[从本章开始，逐个地给出各个层次中的每个模块的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。]4.1模块描述[给出对该基本模块的简要描述，主要说明安排设计本模块的目的意义，并且，还要说明本模块的特点。]4.2功能[说明该基本模块应具有的功能。]4.3性能[说明对该模块的全部性能要求。]4.4输入项[给出对每一个输入项的特性。]4.5输出项[给出对每一个输出项的特性。]4.6设计方法（算法）[对于软件设计，应详细说明本程序所选取用的算法，具体的计算公式及计算步骤。][对于硬件设计，应详细说明本模块的设计原理、元器件的选取、各元器件的逻辑关系，所需要的各种协议等。]4.7流程逻辑[用图表辅以必要的说明来表示本模块的逻辑流程。]4.8接口[说明本模块与其它相关模块间的逻辑连接方式，说明涉及到的参数传递方式。]4.9存储分配[根据需要，说明本模块的存储分配。]4.10注释设计[说明安排的程序注释。]4.11限制条件[说明本模块在运行使用中所受到的限制条件。]4.12测试计划[说明对本模块进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件、驱动程序及桩模块等的规定。]4.13尚未解决的问题[说明在本模块的设计中尚未解决而设计者认为在系统完成之前应解决的问题。]5．模块2（标识符）设计说明[用类似第4条的方式，说明第2个模块乃至第N个模块的设计考虑。][项目名称]——设计说明书45．接口设计5.1用户接口[说明将向用户提供的命令和它们的语法结构，以及相应的回答信息。][说明提供给用户操作的硬件控制面板的定义。]5.2外部接口[说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持系统之间的接口关系。]5.3内部接口[说明本系统之内的各个系统元素之间的接口的安排。]6．运行设计6.1运行模块组合[说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块的支持软件。]6.2运行控制[说明每一种外界的运行控制的方式方法和操作步骤。]6.3运行时间[说明每种运行模块组合将占用各种资源的时间。]7．系统数据结构设计[不涉及软件设计可不包含]7.1逻辑结构设计要点[给出本系统内软件所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。]7.2物理结构设计要点[给出本系统内软件所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系、设计考虑和保密条件。]7.3数据结构与程序的关系[说明各个数据结构与访问这些数据结构的各个程序之间的对应关系。][程序1][程序2][……][程序m][数据结构1]√[数据结构2]√√┇[数据结构n]√√[项目名称]——设计说明书58．系统出错处理设计8.1出错信息[用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。]8.2补救措施[说明故障出现后可能采取的变通措施。包括：]a.后备技术[说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术。]b.降效技术[说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录。]c.恢复及再启动技术[说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。]8.3系统维护设计[说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。]