技术方案规范 作者： truesnow 发布于： 5年前 收录于： 开发规范 163 0 摘要：统一技术方案的模板，根据模板撰写技术方案，可以很轻松的对需求进行拆解，开发时根据技术方案开发，前端根据技术方案联调，测试根据技术方案撰写测试用例。 [TOC] 说明： - [A]：表示新增 - [U]：表示更新 - [D]：表示废弃 > 需求单： # 变更历史 | 版本 | 时间 | 作者 | | --- | --- | --- | | | | | # 分支及版本 GitRepo: `feature-xxx` AppVersion: v1 # 主要逻辑 & 时序图 > 本次需求的主要改动点 - 改动点1 - 改动点2 # 表变更 **表结构变更** > 新建表 SQL、字段变更 SQL **表数据变更** > 新增字段刷数据 SQL、修复数据 SQL # 接口变更 - [A]/api/add：接口名称 - 主要逻辑1 - 主要逻辑2 - [U]/api/update：接口名称 - 变更点1 - 变更点2 # 脚本变更 - [A]AddJobName：任务名称 - 功能点 - 实现逻辑等 - [U]UpdateJob：任务名称 - 变更点 # 配置变更 ``` # desc key = val ``` # 依赖变更 - [A]依赖第三方服务名 - 依赖服务信息 - [U]依赖包 - 变更版本 - 升级原因 # MQ 变更 - [A]topic：新增 topic - group：监听 group - body 格式： ``` { "id": "1", "key": "val" } ``` # 问题点 > 发布顺序 > 有变更的脚本发布时序先切换到预发布执行，并验证，测试无误后再切换到现网执行 无注释版 demo： ```md [TOC] > 需求单： # 变更历史 | 版本 | 时间 | 作者 | | --- | --- | --- | | | | | # 分支及版本 # 主要逻辑 & 时序图 # 表变更 # 接口变更 # 脚本变更 # 配置变更 # 依赖变更 # MQ 变更 # 问题点 ```
所有评论（0）
暂无评论~_~