如何写软件设计文档

1. 如何写软件设计文档

按照以下格式填就好了，不过是我自己写的，有不好的地方大家互相学习修改一下~

详细设计文档规范
1.0概述
这部分提供对整个设计文档的概述。描述了所有数据，结构，接口和软件构件级别的设计。
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 补充信息 (如果有需要特别说明的)

2. 文档的软件设计说明

软件设计阶段结束后要交付软件设计说明书。它的前半部分在概要设计后完成，后半部分在详细设计后写出。设计说明书用于双重目的：对于编程和测试，它提供指南；软件交付使用后，为维护人员提供帮助。软件设计说明书的框架和内容如下：（1）概述。描述设计工作总的范围，包括系统目标、功能、接口等。（2）系统结构。用软件结构图说明本系统的模块划分，扼要说明每个模块的功能，按层次给出各模块之间的控制关系。（3）数据结构及数据库设计。对整个系统使用的数据结构及数据库进行设计，包括概念结构设计、逻辑结构设计和物理设计。用相应的图形和表格把设计结果描述出来。（4）接口设计。设计人机界面，说明向用户提供的命令以及系统的返回信息；设计外部接口，说明本系统与外界的所有接口信息，包括软件与硬件之间的接口、本系统与支持软件之间的接口关系。（5）模块设计。按模块功能详细描述每个模块的流程及数据结构。

3. 如何写软件设计文档？

1 引言
1.1 编写目的
    说明编写这份详细设计说明书的目的，指出预期的读者范围。
1.2 背景
说明：
a． 待开发的软件系统的名称；
b． 列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。
1.3 定义
    列出本文件中用到的专门术语的定义和缩写词的原词组。
1.4 参考资料
列出要用到的参考资料，如：
a． 本项目的经核准的计划任务书或合同、上级机关的批文；
b． 属于本项目的其他已发表的文件；
c． 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

4. 软件设计的介绍

软件设计是从软件需求规格说明书出发，根据需求分析阶段确定的功能设计软件系统的整体结构、划分功能模块、确定每个模块的实现算法以及编写具体的代码，形成软件的具体设计方案。1软件设计是把许多事物和问题抽象起来，并且抽象它们不同的层次和角度。将问题或事物分解并模块化使得解决问题变得容易，分解的越细模块数量也就越多，它的副作用就是使得设计者考虑更多的模块之间耦合度的情况。

5. 软件设计的设计基础

软件设计方法论的这套基本原理已经经过了多年的进化，在软件开发的生命周期中，软件设计是在软件描述提供的的基础上，对软件需求进行分析以形成软件内部结构的描述说明的活动之一。耦合和内聚是两个用来评估软件设计质量的方法。每种概念的影响程度不尽相同，但它们都经历了时间的洗礼。基于这些基本原理设计者可以采用更多更成熟的设计方法。这些基本原理有助于设计者回答以下的问题：1、将软件分割成独立的组件时会采用何种标准？2、怎样将软件的原则性表示详细分割成函数或数据结构？3、有没有定义一个软件设计的技术质量的统一标准？M.A. Jackson 曾经说过：“对一个计算机程序员来说，分辨让程序运行和让程序正确之间的差异是一个良好的开端。”为了“ 使程序正确 ” ，基本设计原理提供了必须的框架。抽象（Abstraction）在最高层次上指的是使用待解决的问题领域内的术语描述的解决方案。相对较低层次的抽象则更多的面向程序语言，最低层的抽象则是解决方案的可直接实现的方式描述。软件设计的每一个步骤都是对相应层次解决方案的抽象的逐步求精。求精（Refinement）又叫做逐步求精指的是通过程序细节连续细化来开发程序体系的策略。分步骤的对程序抽象进行分解直至成为编程语言的过程同时造就了程序的层次结构。在这一点上要对细节多做考虑，这也展示了求精实际上是个苦心经营的过程。模块化（Modularity）指的是软件可被分割为分别命名并可寻址的组件（也叫做模块），将模块综合起来又可以满足问题的需求的性质。 软件的模块化是允许智能化管理程序的唯一属性。 换句话说，当您将一个复杂问题分解为一些小问题时会更容易解决。需要重点解释的是即使一个系统必须象“单片机”一样来实现，它也可以采用模块化设计。软件体系（架构，Software Architecture）涉及到程序的两个重要特性：1） 模块的层次结构。2） 数据结构。这源自于需求分析时将真实世界问题的含蓄定义与软件解决方案的要素关联起来的分割过程。当问题的每个部分通过一个或多个软件要素得到解决后，与问题的定义和解决相一致软件和数据结构的进化就开始了。这个过程代表了软件的需求分析和设计之间的位置。控制层级（Control Hierarchy）也称作程序结构，描述程序组件的组织并意味着控制层级。它并不描述软件的程序方面，比如进程顺序、决定的事件 / 命令、或工作循环。如下的层级图表展示了模块之间的通信流，并显示哪些模块是重复的。这个图表描述了一个能够读文件，计算每个记录的值并书写报表来显示记录的信息和所完成的计算。数据结构（Data structure）描述了单个数据间的逻辑关系。数据结构规定了数据的组织、访问方法、关联程度、和信息的选择处理。数据结构的组织和复杂性只受限于设计者的灵活性。唯一的限制就是经典数据结构的数量阻碍了更多的久经考验的结构出现。软件程序（Software Procedure）着重于处理每个模块的细节并必须提供一个精确的处理规范，包括事件顺序、准确的判定点、重复操作、甚至数据结构。软件的程序表现是分层的，处理方法应该包括其所有子模块的参考。信息隐藏（Information Hiding）的法则建议 由设计决定所刻划的模块特性应该对其余的模块不可见。换句话说，模块应被设计和指定为包含在模块内部且其他模块不可访问的内容对其他模块来说是无需的。隐藏意味着有效的模块性能够通过定义一套独立的模块来实现，这些模块相互之间的通信仅仅包括实现软件功能的所必须的信息。将使用信息隐藏作为设计标准在测试或今后的维护期间需要修改系统时带来了最大的好处。