本分区统一保存跨项目的系统架构、服务边界、接口契约、数据库设计、状态机、消息链路和兼容方案,作为需求开发、评审、联调、上线和后续维护的技术依据。
默认内容
- 系统上下游、模块职责和调用关系。
- API 路径、请求参数、响应字段、错误码和幂等规则。
- 表结构、字段口径、索引、默认值、快照和关联关系。
- 状态机、业务事件、MQ routing key、回调和补偿任务。
- 兼容旧逻辑的条件、灰度策略、迁移步骤和回归范围。
目录约定
按 <项目名>/ 建立子目录,同一业务专题尽量把架构、API、表、状态和消息流程串成一篇可独立理解的文档。需要随前端联调的 mock 文档可以继续保留在项目约定位置,但稳定后的业务契约应同步沉淀到这里。
完成标准
文档必须能回答入口在哪里、数据如何流转、状态如何变化、异常如何补偿、如何验证以及修改会影响哪些旧流程。