软件设计项目说明指导书模板.doc

[项目名称]

设计说明书

[V1.0(版本号)]

拟 制 人______________________
审 核 人______________________
批 准 人______________________

[年月日]
设计说明书
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.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. 系统结构
[给出系统结构框图，包含软件结构、硬件结构框图。用一系列图表列出系统内每个模块名称、标识符和它们之间层次结构关系。]

4．模块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个模块设计考虑。]

5．接口设计
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]

√

√

8．系统犯错处理设计
8.1犯错信息
[用一览表方法说明每种可能犯错或故障情况出现时，系统输出信息形式、含意及处理方法。]

8.2补救方法
[说明故障出现后可能采取变通方法。包含：]
a. 后备技术 [说明准备采取后备技术，当原始系统数据万一丢失时启用副本建立和开启技术，比如周期性地把磁盘信息统计到磁带上去就是对于磁盘媒体一个后备技术。]
b. 降效技术 [说明准备采取后备技术，使用另一个效率稍低系统或方法来求得所需结果一些部分，比如一个自动系统降效技术能够是手工操作和数据人工统计。]
c. 恢复及再开启技术 [说明将使用恢复再开启技术，使软件从故障点恢复实施或使软件从头开始重新运行方法。]

8.3系统维护设计
[说明为了系统维护方便而在程序内部设计中作出安排，包含在程序中专门安排用于系统检验和维护检测点和专用模块。]