设计说明书怎么写，应该注意什么？正确格式？

Question

如题所述

Answer 1

概要设计说明书又可称系统设计说明书，这里所说的系统是指程序系统。编制的目的是说明对程序 系统的设计考虑，包括程序系统的基本处。流程、程序系统的组织结构、模块划分、功能分配、接口设计。 运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。

编制概要设计说明书的内容，要求如下：
11．1引言
11.1． 1编写目的
11．1．2背景
11．1．3定义
11.1．4参考资料
11.2总体设计
11.2.1需求规定
11.2．2运行环境
11．2．3基本设计概念和处理流程
11． 2． 4”结构
11．2．5功能需求与程序的关系
11． 2． 6人工处理过程
11．2．7尚未解决的问题
11．3接口设计
11．31用户接口
11．32外部接口
11．3 3内部接口
11．4运行设计
11. 4. 1运行模块组合
11.4.2运行控制
11.4.3运行时间
11.5系统论据结构设计
11. 5. 1逻辑结构设计要点
11. 5. 2物理结构设计要点
11.5.3数据结构与程序的关系
11． 6系统出错处理设计
11. 6. 1出错信息
11.6．2补救措施
11.6 3系统维护设计

概要设计说明书的编写提示（参考件）

E.1引言
E.1.1编写目的
说明编写这份概要设计说明书的目的，指出预期的读者。
E.1.2背景
说明：
a．待开发软件系统的名称；
b．列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。
E.1．3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
E.1.4参考资料
列出有关的参考文件，如：
a．本项目的经核准的计划任务书或合同，上级机关的批文；
b．属于本项目的其他已发表文件；
c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
E.2总体设计
E.2.1需求规定
说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。
E.2.2运行环境
简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。
E．2．3基本设计概念和处理流程
说明本系统的基本设计概念和处理流程，尽量使用图表的形式。
E.2.4结构
用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.
E.2.5功能器求与程序的关系
本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：

E．2．6人工处理过程
说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。
E.2.7尚未问决的问题
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
E．3 接口设计
E．3．1用户接口
说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。
E．3.2外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接 口关系。
E．3．3内部接口
说明本系统之内的各个系统元素之间的接口的安排。
E．4运行设计
E．4．1运行模块组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。
E．4．2运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
E．4．3运行时间
说明每种运行模块组合将占用各种资源的时间。
E.5系统数据结构设计
E.5．1逻辑结构设计要点
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
E.5．2物理结构设计要点
给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。
E.5.3数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式:

E.6系统出错处理设计
E.6.1出错信息
用一览表的方式说朗每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。
E.6.2补救措施
说明故障出现后可能采取的变通措施，包括：
a.后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；
b．降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；
c．恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。
E.6.3系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 各个程序之间的对应关系，可采用如下的矩阵图的形式；