技术评审文档模板。

技术评审文档模板

版本变更记录

文档版本	撰写人	时间	变更原因	其他
1.0	XXX	2020-8-19	新建

1、背景简介

目标
（非必选，简述文档目标，使读者清楚当前文档的描述背景和范围，可以摘抄部分产品需求。如果有上下文目录结构，本节可省略）

相关资料

必选，链接需求文档地址或者JIRA地址，有关能够交代当前需求背景的文档链接都可以，方便读者通过链接资源更全面理解当前设计背景）
（文档包括但不限于：需求文档、JIRA任务文档、软件相关技术、软件技术标准、软件参考文献、软件引用资料、参考书籍/杂志/文章链接 ）
（技术设计文档与后续系统文档的延续关系，以及保障更新的流程机制）

通用语言
（ 非必选， 对新增名称，需要补充到通用语言中，本节侧重名称选择和翻译。避免前端、后端、BI同学同一名称使用不同翻译，根据需要进行剪裁，可以使
用表格或者链接形式进行体现）

名词解释
（ 非必选，对新增专业名词、存在歧义的名称、业务定义的名词进行解释，目的是使读者更容易的理解后面所提到的概念）

名词	解释

2、整体设计

需求功能较多、版本迭代较大的场景下，建议单独文档或者章节描述各个服务/模块之间的关系，形式可以参照如下目录，如果需求较少或者服务内设计，
本节可省略）
……
需求范围
（非必选，实现功能范围概述，包括：新增需求、变更需求，帮着阅读者回顾需求内容及同步需求评审后的需求变更）
新增需求：……
变更需求：……
整体架构
（ 技术自驱的必选、倒排期需求可选，新项目启动必选，使用图示的方式，描述本次设计整体架构）

领域分析
（非必选，采用领域驱动设计可以将分析过程描述到此处。子域、限界上下文、上下文映射，本章节内容后续可以采用单独单独章节进行详细描述，本章节
只描述领域整体情况）
……
交互方/三方
（ 非必选， 交互较为复杂的场景，需要补充第三方交互接口整理文档）