design-doc-template.md 1.4 KB

技术方案:【方案名称】

文档元数据(每次修改必须更新)

字段 值
关联 PRD PRD-YYYYMMDD-功能名
版本号 v1.0
最后更新日期 YYYY-MM-DD
状态 草稿 / 评审 / 生效 / 废弃
本次变更原因 首次创建 / 方案调整(说明)

一、背景

  • 需求来源与问题描述
  • 现状(现有实现/数据/接口)

二、方案对比

方案 描述 优点 缺点 结论
A
B
  • 选定方案:A / B
  • 选型理由:

三、总体设计

  • 架构说明(可用 mermaid 图):
  • 模块划分与职责:
  • 数据流 / 业务流程(可用 mermaid sequenceDiagram / flowchart):

四、数据模型变更

  • 新增/修改的表与字段(需同步:ER 图 + 表结构文档 + schema 脚本)
  • 字段说明、类型、默认值、约束

五、接口设计

  • 新增/修改的 API(需同步 API 文档)
  • 请求/响应示例、错误码

六、涉及文件清单

  • 前端:
  • 后端:
  • 文档(需同步):

七、风险与应对

风险 影响 应对措施

八、回滚方案

  • 回滚方式与步骤:

九、评审记录

日期 评审人 结论 意见摘要
YYYY-MM-DD

十、变更历史

版本 日期 变更内容 变更原因
v1.0 YYYY-MM-DD 首次创建