技术评审之技术文档的规范模板

“技术评审”和需求评审与case评审一样，是项目过程中重要且不可或缺的一个环节。

技术评审由该项目的技术owner组织并产出最终文档。

通过技术评审，与阅读技术文档，可以让各个角色，包括不限于产品，合作方研发工程师，测试工程师更深入了解项目架构与实现方式。且更好的进行后续维护。

技术文档规范模板如下：

                           xx项目开发设计文档

需求：需求链接

1 . 流程图

1.1 系统架构图（以下为参考案例）

1.2 系统流程图（以下为参考案例）

1.3 状态流程图（以下为参考案例） 

2. 表结构设计（以下为参考案例）

2.1 活动表（本次新增的表）

-- auto-generated definition
create table activity
(
    id                      bigint unsigned auto_increment
        primary key,
    title                   varchar(255) default ''                not null comment '活动标题'
)
    comment '营销活动信息';

create index IDX_CUSTOM_ID
    on activity (merchant_custom_id);

create index merchant_id
    on activity (merchant_id);

2.2 用户行为记录表（增加了2个字段）

    create_at               datetime     default CURRENT_TIMESTAMP not null comment '创建时间',
    update_at               datetime     default CURRENT_TIMESTAMP not null on update CURRENT_TIMESTAMP comment '更新时间'                         

3. 接口设计

3.1 order/create（新增接口）

接口地址（yapi / swagger / 接口文档）

3.2 refund/apply （修改）

接口地址（yapi / swagger / 接口文档）

4. 配置与中间件

4.1 配置

4.2 redis

4.3 mq

4.4 ES

4.5 定时任务

5. 注意事项

6. 回归范围

7. 存疑点（技术评审时需要讨论的点）