如何写好研发技术方案

如何写好技术方案

本文将介绍一个成熟的研发技术方案应该具有的东西，缺少的部分请大家在评论中补充

一、概述

概述部分应该明确需求背景，明确的需求或者说目标，以及根据这个目标可以拆解出哪些大块的任务

需求以及拆解的目标

拆解任务

二、架构设计

服务架构

tips: 应该包含一个整体的架构图、时序图、流程图

工程架构

tips: 可以是项目目录

技术选型

tips: 关键或难点处技术选型、选它的原因

数据模型

tips: 表结构和关联关系要明确好，画好 ER 图

接口列表

tips: 提供一个接口文档

三、稳定性&安全性

稳定性

• 日志收集
• 监控报警
• 压测

安全性

• 基本的安全防护如 csrf,xss,xsrf 等
• 申请测试环境 or 线上环境公司安全检查

四、项目排期

tips: 可以在技术评审完成后进行补充，包括开发排期，联调排期和预估的上线时间

五、风险项

tips: 罗列可能的风险项