如何写软件设计文档

一、概论1、编写目的2、编写背景3、对系统的大致描述

二、业务概述和逻辑设计1、对系统几大主体的描述2、对系统几大业务流程描述3、用UML对其进行总体描述

三、技术架构在此章决定使用那种技术体系，具体的技术有那些，描述他们之间是怎么协同运作的。

四、功能模块设计描述系统有那些主要功能，这些功能应该用何种技术，大致是如何实现的,

五、接口设计

六、应急系统设计

七、安全设计描述系统应该具有的安全级别，以及达到此安全等级的所采用的技术措施

八、运行环境设计从硬件网络方面描述概要设计的目的就是希望一个从来没有接触过的人一看就能从各个方面都对系统的作用，功能，实现方面有一个大概了解，并为以后的各类详细设计文档提供一个指引和方向。

一、编写目的

二、应用文档

三、要求及内容

2.1编写格式要求

2.2说明书内容

2.2.1说明书目的

2.2.2参考资料及文档

2.2.3设计原则

2.2.4接口描述

2.2.5功能描述

2.2.6接口协议

2.2.7编程协定

2.2.8数据结构

2.2.9逻辑结构

2.2.10程序流程

2.2.11源文件列表

2.2.12其他

2.3文档修订历史

四、编写文档注意事项

五、样例及模板文档

软件文档可以分为开发文档和产品文档两大类。

开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《 QA 文档》、《项目总结》等。

产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》。

用户文档《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。

一个人的精力有限，不可能总是记忆设计程序时的思路，要求，因此需要用设计文档记录软件开发中的细节内容，以便以后重新涉及时可以查阅和回忆，迅速上手

当前软件设计一般是团队合作，如果想让其他开发人员接手继续设计，详细的设计文档可以使交接过程变得简单，否则先前的设计可能会白做了

在管理层面，项目负责人需要详细的文档，以便总结开发设计过程，使设计完整

综上所述，除非微小项目，一般都需要详细的设计文档，尤其是团队软件开发场合更是必须

软件设计阶段结束后要交付软件设计说明书。它的前半部分在概要设计后完成，后半部分在详细设计后写出。设计说明书用于双重目的：对于编程和测试，它提供指南；软件交付使用后，为维护人员提供帮助。软件设计说明书的框架和内容如下：

（1）概述。描述设计工作总的范围，包括系统目标、功能、接口等。

（2）系统结构。用软件结构图说明本系统的模块划分，扼要说明每个模块的功能，按层次给出各模块之间的控制关系。

（3）数据结构及数据库设计。对整个系统使用的数据结构及数据库进行设计，包括概念结构设计、逻辑结构设计和物理设计。用相应的图形和表格把设计结果描述出来。

（4）接口设计。设计人机界面，说明向用户提供的命令以及系统的返回信息；设计外部接口，说明本系统与外界的所有接口信息，包括软件与硬件之间的接口、本系统与支持软件之间的接口关系。

（5）模块设计。按模块功能详细描述每个模块的流程及数据结构。

1 概述

1.1 系统简述

对系统要完成什么，所面向的用户以及系统运行的环境的简短描述，这部分主要来源于需求说明书的开始部分。

1.2 软件设计目标

这部分论述整个系统的设计目标，明确地说明哪些功能是系统决定实现而哪些时不准备实现的。同时，对于非功能性的需求例如性能、可用性等，亦需提及。需求规格说明书对于这部分的内容来说是很重要的参考，看看其中明确了的功能性以及非功能性的需求。

这部分必须说清楚设计的全貌如何，务必使读者看后知道将实现的系统有什么特点和功能。在随后的文档部分，将解释设计是怎么来实现这些的。

1.3 参考资料

列出本文档中所引用的参考资料。（至少要引用需求规格说明书）

1.4 修订版本记录

列出本文档修改的历史纪录。必须指明修改的内容、日期以及修改人。

2 术语表

对本文档中所使用的各种术语进行说明。如果一些术语在需求规格说明书中已经说明过了，此处不用再重复，可以指引读者参考需求说明。

3 用例

此处要求系统用用例图表述（UML），对每个用例（正常处理的情况）要有中文叙述。

4 设计概述

4.1 简述

这部分要求突出整个设计所采用的方法（是面向对象设计还是结构化设计）、系统的体系结构（例如客户/服务器结构）以及使用到的相应技术和工具（例如OMT、Rose）

4.2 系统结构设计

这部分要求提供高层系统结构的描述，使用方框图来显示主要的组件及组件间的交互。最好是把逻辑结构同物理结构分离，对前者进行描述。别忘了说明图中用到的俗语和符号。

4.2.1 顶层系统结构

4.2.2 子系统1结构

4.2.3 子系统2结构

4.3 系统界面

各种提供给用户的界面以及外部系统在此处要予以说明。如果在需求规格说明书中已经对用户界面有了叙述，此处不用再重复，可以指引读者参考需求说明。如果系统提供了对其它系统的接口，比如说从其它软件系统导入/导出数据，必须在此说明。

4.4 约束和假定

描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。说明系统是如何来适应这些约束的。

另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。这种情况下，要求清楚地描述与本系统有交互的软件类型（比如某某某数据库软件，某某某EMail软件）以及这样导致的约束（比如只允许纯文本的Email）。

实现的语言和平台也会对系统有约束，同样在此予以说明。

对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡，为什么要采取这样的设计等等。

5 对象模型

5.1 系统对象模型

提供整个系统的对象模型，如果模型过大，按照可行的标准把它划分成小块，例如可以把客户端和服务器端的对象模型分开成两个图表述。

对象图应该包含什么呢？

在其中应该包含所有的系统对象。这些对象都是从理解需求后得到的。要明确哪些应该、哪些不应该被放进图中。

所有对象之间的关联必须被确定并且必须指明联系的基数（一对一、一对多还是多对多，0..1，*，1..*）。聚合和继承关系必须清楚地确定下来。每个图必须附有简单的说明。

可能经过多次反复之后才能得到系统的正确的对象模型。

6 对象描述

在这个部分叙述每个对象的细节，它的属性、它的方法。在这之前必须从逻辑上对对象进行组织。你可能需要用结构图把对象按子系统划分好。

为每个对象做一个条目。在系统对象模型中简要的描述它的用途、约束（如只能有一个实例），列出它的属性和方法。如果对象是存储在持久的数据容器中，标明它是持久对象，否则说明它是个临时对象（transient object）。

对每个对象的每个属性详细说明：名字、类型，如果属性不是很直观或者有约束（例如，每个对象的该属性必须有一个唯一的值或者值域是有限正整数等）。

对每个对象的每个方法详细说明：方法名，返回类型，返回值，参数，用途以及使用的算法的简要说明（如果不是特别简单的话）。如果对变量或者返回值由什么假定的话，Pre-conditions和Post-conditions必须在此说明。列出它或者被它调用的方法需要访问或者修改的属性。最后，提供可以验证实现方法的测试案例。

6.1 子系统1中的对象

6.1.1 对象：对象1

用途：

约束：

持久性：

6.1.1.1 属性描述：

1. 属性：属性1

类型：

描述：

约束：

2. 属性：属性2

6.1.1.2 方法描述：

1. 方法：方法1

返回类型：

参数：

返回值：

Pre-Condition：

Post-Condition：

读取/修改的属性：

调用的方法：

处理逻辑：

测试例：用什么参数调用该方法，期望的输出是什么……

7 动态模型

这部分的作用是描述系统如何响应各种事件。例如，可以建立系统的行为模型。一般使用顺序图和状态图。

确定不同的场景（Scenario）是第一步，不需要确定所有可能的场景，但是必须至少要覆盖典型的系统用例。不要自己去想当然地创造场景，通常的策略是描述那些客户可以感受得到的场景。

7.1 场景（Scenarios）

对每个场景做一则条目，包括以下内容：

场景名：给它一个可以望文生义的名字

场景描述：简要叙述场景是干什么的以及发生的动作的顺序。

顺序图：描述各种事件及事件发生的相对时间顺序。

7.1.1 场景：场景1

描述：

动作1

动作2

7.2 状态图

这部分的内容包括系统动态模型重要的部分的状态图。可能你想为每个对象画一个状态图，但事实上会导致太多不期望的细节信息，只需要确定系统中一些重要的对象并为之提供状态图即可。

7.2.1 状态图1：

8 非功能性需求

在这个部分，必须说明如何处理需求文档中指定的非功能性需求。尽可能客观地评估系统应付每一个非功能性的需求的能力程度。如果某些非功能性需求没有完全在设计的系统中实现，请务必在此说明。另外，你也需要对系统将来的进化作一个估计并描述本设计如何使系统能够适应这些可预见的变化。

9 辅助文档

提供能帮助理解设计的相应文档。

10 词汇索引

文章录入

1.1 目标和对象 描述软件对象的所有目标。

1.2 陈述范围 软件描述。主要输入，过程功能，输出的描述，不考虑详细细节。

1.3 软件内容 软件被置于商业或者产品线中，讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。

1.4 主要系统参数 任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。

2.0 数据设计 描述所有数据结构包括内部变量，全局变量和临时数据结构。

2.1 内部软件数据结构 描述软件内部的构件之间的数据传输的结构。

2.2 全局数据结构 描述主要部分的数据结构。

2.3 临时数据结构 为临时应用而生成的文件的描述。

2.4 数据库描述 作为应用程序的一部分，描述数据库结构。

3.0 结构化和构件级别设计 描述程序结构。

3.1 程序结构 详细描述应用程序所选定的程序结构。

3.1.1 结构图 图形化描述结构。

3.1.2 选择性 讨论其它可供考虑的结构。选定3.1.1中结构类型的原因。

3.2 构件描述 详细描述结构中的每个软件构件。

3.2.1 构件过程叙述(PSPEC) 描述构件的过程。

3.2.2 构件接口描述 详细描述构件的输入和输出。

3.2.3 构件执行细节 每个构件的详细演算描述。

3.2.3.1 接口描述

3.2.3.2 演算模型(e.g., PDL)

3.2.3.3 规范/限制 ]

3.2.3.4 本地数据结构

3.2.3.5 在3.2.3.6设计中包含的执行结果

3.3 软件接口描述 软件对外界的接口描述

3.3.1机器对外接口 与其他机器或者设备的接口描述。

3.3.2系统对外接口 对其它系统、产品和网络的接口描述。

3.3.3与人的接口 概述软件与任何人的界面。

4.0 用户界面设计 描述软件的用户界面设计。

4.1 描述用户界面 详细描述用户界面，包括屏幕显示图标、图片或者类型。

4.1.1 屏幕图片 从用户角度描述界面。

4.1.2 对象和操作 所有屏幕对象和操作的定义。

4.2 界面设计规范 用户界面的设计和实现的规范和标准。

4.3 可见构件 实现的GUI可见构件说明。

4.4 UIDS描述 用户界面开发系统描述。

5.0约束、限制和系统参数 会影响软件的规格说明、设计和实现的特殊事件。

6.0测试标准 测试策略和预备测试用例描述。

6.1 测试的类别 规定实施测试的类别，包括尽量详细的描述。这里是针对黑盒测试现象的描述。

6.2期待软件反馈 测试期待的结果描述。

6.3执行界线 特殊执行需要的说明。

6.4 重要构件确认 决定性构件或者需要特殊注意的构件的测试确认。

7.0附录 设计说明的补充信息。

7.1系统可跟踪矩阵 一个定期回归系统规格跟踪软件需求的矩阵。

7.2 产品战略 如果规格说明书是为一个产品设计的，描述相关的产品战略。

7.3 使用分析算法 描述所有分析活动所使用到的分析算法。

7.4 补充信息 (如果有需要特别说明的)

其内容格式可参见如下：

一、软件概述（背景，功能，特点等）、

二、软件、硬件配置要求

三、软件功能

1、总体介绍

2、总体流程图

3、功能描述（以其中一个功能为例）

1）

功能1

详细介绍（包含的模块等）

模块1

详细介绍（包含的模块等）

实现方式

模块设计流程图

流程介绍

……

模块2

……

功能2

……

表述完毕后，还可进行总结性地描述或添加数据结构、参数表格的描述。

如有不明可留言详解！

在具体实践中可以按下列提纲撰写内容：

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.3可靠性

2.1.2.4灵活性

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功能需求与系统模块的关系

[本条用一张矩阵图说明各项功能需求的实现同各模块的分配关系。]

2.6人工处理过程

[说明在本系统的工作过程中不得不包含的人工处理过程。]

2.7尚未解决的问题

[说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。]

3．接口设计

3.1用户接口

[说明将向用户提供的命令和它们的语法结构，以及相应的回答信息。]

[说明提供给用户操作的硬件控制面板的定义。]

3.2外部接口

[说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持系统之间的接口关系。]

3.3内部接口

[说明本系统之内的各个系统元素之间的接口的安排。]

4．运行设计

4.1运行模块组合

[说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块的支持软件。]

4.2运行控制

[说明每一种外界的运行控制的方式方法和操作步骤。]

4.3运行时间

[说明每种运行模块组合将占用各种资源的时间。]

5．系统数据结构设计

[不涉及软件设计可不包含]

5.1逻辑结构设计要点

[给出本系统内软件所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。]

5.2物理结构设计要点

[给出本系统内软件所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系、设计考虑和保密条件。]

5.3数据结构与程序的关系

[说明各个数据结构与访问这些数据结构的各个程序之间的对应关系。]

6．系统出错处理设计

6.1出错信息

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

6.2补救措施

[说明故障出现后可能采取的变通措施。]

6.3系统维护设计

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