系统设计说明书(架构、概要、详细)目录结构

出自： http://hi.baidu.com/gaoxiaopan/blog/item/2adf220633584072030881ca.html

XXX 架构设计说明书

( 架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系 )

一. 概述

描述本文的参考依据、资料以及大概内容。

二. 目的

描述本文编写的目的。

三. 架构设计

阐明进行架构设计的总体原则，如对问题域的分析方法。

3.1.       架构分析

对场景以及问题域进行分析，构成系统的架构级设计，阐明对于系统的分层思想。

3.2.       设计思想

阐明进行架构设计的思想，可参考一些架构设计的模式，需结合当前系统的实际情况而定。

3.3.       架构体系

根据架构分析和设计思想产生系统的架构图，并对架构图进行描述，说明分层的原因、层次的职责，并根据架构图绘制系统的物理部署图，描述系统的部署体系。

3.4.       模块划分

根据架构图进行模块的划分并阐明模块划分的理由，绘制模块物理图以及模块依赖图。

3.4.1.       模块描述

根据模块物理图描述各模块的职责，并声明其对其他模块的接口要求。。

3.4.2.       模块接口设计

对模块接口进行设计，并提供一定的伪代码。

XXX 概要设计说明书

( 概要设计重点在于将模块分解为对象并阐明对象之间的关系 )

一. 概述

描述本文的参考依据、资料以及大概内容。

二. 目的

描述本文的编写目的。

三. 模块概要设计

引用架构设计说明书中的模块图，并阐述对于模块进行设计的大致思路。

3.1.       设计思想

阐明概要设计的思想，概要设计的思想通常是涉及设计模式的。

3.2.       模块 A

3.2.1.       概要设计

根据该模块的职责对模块进行概要设计 ( 分解模块为对象、描述对象的职责以及声明对象之间的接口 ) ，绘制模块的对象图、对象间的依赖图以及模块主要功能的序列图，分别加以描述并相应的描述模块异常的处理方法。

3.2.2.       模块接口实现

阐明对于架构设计中定义的模块接口的实现的设计。

XXX 详细设计说明书

( 详细设计重点在于对模块进行实现，将模块的对象分解为属性和方法，并阐述如何实现 )

一. 概述

阐述本文的参考依据、资料以及大概内容。

二. 目的

阐述本文的编写目的。

三. 模块详细设计

3.1.       设计思想

阐述对模块进行详细设计的思想。

3.2.       模块 A

3.2.1.       详细设计

根据模块概要设计详细描述对于模块内对象的实现，包括对象的职责、属性、方法、对象内功能的流程图、对象关联的类、对象的异常。 ( 需要绘制的主要为类图 )

详细设计说明书的编写提示（参考件）

　　F.1引言

　　F.1.1编写目的

　　说明编写这份详细设计说明书的目的，指出预期的读者。

　　F.1.2背景

　　说明：

　　a．待开发软件系统的名称；

　　b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。

　　F.1.3定义

　　列出本文件中用到专门术语的定义和外文首字母组词的原词组。

　　F.1.4参考资料

　　列出有关的参考资料，如：

　　a．本项目的经核准的计划任务书或合同、上级机关的批文；

　　b．属于本项目的其他已发表的文件；

　　c.本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。

　　F.2程序系统的结构

　　用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系。

　　F.3程序1（标识符）设计说明

　　从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。 对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。

　　F.3.1程序描述

　　给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如 是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发 处理卜…..等）。

　　F.3.2功能

　　说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。

　　F.3.3性能

　　说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。

　　F.3.4输入项

　　给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。 数量和频度、输入媒体、输入数据的来源和安全保密条件等等。

　　F. 3. 5输出项

　　给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、 数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。

　　F．3．6算法

　　详细说明本程序所选用的算法，具体的计算公式和计算步骤。

　　F．3．7流程逻辑

　　用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。

　　F．3.8接口

　　用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。

　　F．3.9存储分配

　　根据需要，说明本程序的存储分配。

　　F．3．10注释设计

　　说明准备在本程序中安排的注释，如：

　　a. 加在模块首部的注释；

　　b．加在各分枝点处的注释； 对各变量的功能、范围、缺省条件等所加的注释；

　　d．对使用的逻辑所加的注释等等。

　　F．3.11限制条件

　　说明本程序运行中所受到的限制条件。

　　F．3．12测试计划

　　说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。

　　F．3.13尚未解决的问题

　　说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。

　　F．4程序2（标识符）设计说明

　　用类似F．3的方式，说明第2个程序乃至第N个程序的设计考虑。

户外精品， 请来jfhw360.taobao.com[size=medium][/size]