软件设计文档模板和各个部分说明

SASD 模式的文档

sa：系统分析
sd：系统设计
sp：结构化编程

系统分析

数据流分析

需求明确

描述系统功能的整体目标和范围，描述各个部分（应用级别、模块级别）的职责范围和功能目标。

数据流概况

该部分以应用或者模块为单位进行总览，建立顶层的数据流（DFD）视图。

xxx 模块数据流

描述具体的模块部分的数据流视图，具体说明模块的边界和目标问题。

XXX 环节数据流

针对上一层数据流的关键流程进行更进一步的描述，重点描述难理解的或者关键的流程环节数据流视图细节。

数据字典

数据项和数据结构的说明文件。具体可以模仿 mysq 等的表结构格式来描述。
数据项：名称、含义、别名、类型、长度、范围、取值含义、与其他数据项的逻辑关系
数据结构：名称、含义、组成结构
数据流：名称、说明、来源、去向、传输的数据结构、流量信息（tps、max）
数据存储：名称、说明、存储内容、数据量、
处理过程：名称、输入、输出、简要处理说明（处理过程的功能和处理说明）

系统设计文档

系统设计是一个自顶向下、逐步细化的过程，主要包括概要设计和详细设计。
概要设计旨在说明框架结构信息、模块划分和功能信息、接口和模块的调用关系。
详细设计旨在说明模块的具体功能和关键算法的详细实现说明。

概要设计

架构

模块功能结构和功能

往往模块用来自由组合，所以尽量是无状态的。
模块的抽象一般可以走分层的思想，对过程、数据、控制流程进行抽象。
模块是基本的功能单位。
所以该部分旨在描述模块的外部特性（对外表现或者说对外接口的描述）和内部特性（具体实现和处理）。

外部特性

模块的外部特性包括功能、‌输入和输出。‌
功能：‌模块所能执行的任务或操作。‌
输入：‌模块接收的数据或其他资源，‌以便进行相应的处理。‌
输出：‌模块处理后的结果或产生的数据，‌提供给其他模块或系统使用。‌

内部特性

内部数据：指模块内部使用的数据，这些数据仅供模块内部使用，不对外公开。
运行程序：包括模块执行其功能所需的程序代码，这是实现模块功能的实际指令集。
逻辑处理功能：描述模块内部如何实现要求的功能，即模块的功能逻辑和算法实现。

模块调用或者依赖关系

详细设计

详细设计描述的是模块的具体设计，关键算法、流程和局部的数据结构说明

xxx 模块

关键流程

输入输出结构

数据结构补充

数据库设计

结构设计、命令语句、配置说明，结合E-R图来进行说明