设计与方案

本目录用于存放“还在设计阶段”或“需要长期参考的设计文档”。它强调“方案对比与可落地的细节”,但不等同于最终决策。

这个目录放什么

  • 需求拆解:目标、非目标、约束、边界条件
  • 方案对比:备选方案、优缺点、风险、迁移路径
  • 接口/协议设计:HTTP/RPC/CLI、请求响应、错误码、版本策略
  • 数据结构与存储:Schema、索引、兼容与演进
  • 测试与可观测性:关键用例、回归点、指标与告警

这个目录不放什么

  • “已经定了”的最终结论(放到 adr/,并从这里链接过去)
  • 会议纪要、零散讨论(放到 discussions/

推荐模板(建议包含)

  • 背景与问题
  • 目标/非目标
  • 方案与权衡
  • 兼容性与演进
  • 落地计划(里程碑/回滚方案)