设计文档格式

修订记录

日期	修订版本	修改描述	作者	审核

1. 名词解析

• 名词1： xxxxxxxxx

• 名词2: xxxxxx

2. 概述

这个需求的背景是怎么样的？为了做什么来写这个文档。讲清楚要做什么？为什么？

概述是个整体描述，让人明白要做什么，也可以叫做需求分析。

3. 需求分析

需求的发散扩展到安全性以及需求风险等等。

主要需求点提炼（要求言简意赅，看完就可以知道大概要做什么）

愿景或者目标

4. 概要设计

// 现在概要设计讲述整体的实施方案 （要求言简意赅，看完就可以知道大概要做什么）

// 由整体到部分的过程 主要阐述每一个功能怎么做的 可以采用流程图 时序图

// 常用画图工具 drawio、processon

1.总设计

2.拆分功能点

3.其他设计 外部对接等

5. 详细设计

5.1. 数据库设计

// 为啥设计这个表，综合考虑业务新增索引
// er图

5.2. 类设计

// 类图

5.3. 接口设计

5.3.1 xxx功能

Header参数

参数名称	参数值	是否必须	示例	备注
token	xxxxxxx	是	token=xxxxx	token

请求URL:

• POST /xxxx/xxxx/xxxx

请求参数

请求参数	参数类型	是否必须	长度	参数说明
xxxx	Integer	是	-	参数说明

请求示例

{
xxxxx
}

正确返回结果

{
xxxx
}