docs: organize contracts by business domain

This commit is contained in:
2026-09-04 16:44:08 +08:00
parent 703f869841
commit 40492cdae8
79 changed files with 916 additions and 852 deletions
+31 -24
View File
@@ -1,37 +1,44 @@
# 虫虫出海文档索引
项目交付文档按阶段归档,跨阶段原型、调研和过程设计保留在原专题目录。
项目交付文档按业务域组织。当前开发环境以端到端全流程为统一范围;历史规划、确认和验收记录保留在对应业务域目录,仅用于追溯决策,不构成功能边界。
## 阶段文档
## 业务域文档
- [一期文档](一期/README.md):一期范围、开发进度和头程订单最小闭环。
- [二期文档](二期/README.md):预约取货、到仓收货、实测差异和指定库位闭环。
- [三期文档](三期/README.md):智能排柜、订舱、拖车、PDA 拣货、报关协同和国内出仓闭环。
- [四期文档](四期/README.md):国内出仓后的船节点定时查询、海外接柜、合作仓卸货入库、库存与库内操作,以及海外采购、本土卡车和本土散板;不包含海外仓出库业务。
- [船节点标准化契约](四期/船节点标准化契约.md):统一船司原始状态、十个标准节点、预计/实际时间、异常事实、还柜停止规则和新增船司接入门禁。
- [测试环境独立任务协作登记](独立任务协作登记.md):只维护测试环境系统总控与长期专项的稳定 `task_id`、父子关系、职责和测试数据库授权。
- [开发环境独立任务协作登记](开发环境独立任务协作登记.md):只维护开发环境五期总控与专项的稳定 `task_id`、projectId、职责及开发数据库/部署/HTTP 授权。
- [订单与客户](订单与客户/README.md):登录认证、客户与企业、权限、头程订单和客户工作台。
- [入库测量与计费](入库测量与计费/README.md):预约取货、到仓收货、箱码与箱唛、测量、尺寸策略、计价和入库费用。
- [国内货柜履约](国内货柜履约/README.md):分柜与同柜、智能排柜、订舱、拖车、PDA 拣货、装柜、报关和国内出仓。
- [海外仓业务](海外仓业务/README.md):船节点、海外接柜、入仓、库存、托盘、换标、转运、废弃、退货、排车、PDA 出库、派送、异常退回、客户回访、一件代发及海外本土业务。
- [船节点标准化契约](海外仓业务/船节点标准化契约.md):统一船司原始状态、标准节点、预计/实际时间、异常事实、还柜停止规则和新增船司接入门禁。
- [财务管理](财务管理/README.md):应收、应付、费用池、账单、收款、成本、核销、凭证以及国内外业务费用来源。
## 跨阶段参考
## 全流程公共契约
- [跨区域认证与服务通信契约](跨区域认证与服务通信契约.md):统一账号、国内/海外 Token、双区域 API、JWKS、Outbox/Inbox 与服务身份边界。
- [双区域部署与 Nacos 规划](双区域部署与Nacos规划.md):开发/测试同机共置、生产国内/海外独立控制面、Nacos、数据库及 Event Bridge 部署边界。
- [阿里云生产环境选型、压测与上线手册](阿里云生产环境选型压测与上线手册.md):面向新手运维的 ECS/ALB、RDS MySQL、Tair/Redis、OSS、MSE Nacos、RocketMQ 选型,压测步骤、高可用演练、监控、备份与上线清单。
- [平台、客户层级与权限契约](平台客户层级与权限契约.md):平台/客户两级产品语义、列表包含详情的只读权限和跨层同步要求。
- [AI 工程执行与协作约束](AI工程执行与协作约束.md):临时目录、依赖复用、当前开发阶段、部署数据库授权、质量门禁和独立任务协作规则。
- [财务管理闭环盘点与范围建议](财务管理/README.md):基于当前入库计费、财务原型和现有代码盘点财务闭环、缺口及建议的首期应收边界。
- [墨家设备测量上传接口说明 V3](墨家设备测量上传接口说明-V3.md):墨家测量设备经 Gateway 上传箱码、尺寸、重量和图片的开放接口契约。
- [统一订单主状态与操作契约](统一订单主状态与操作契约.md):统一订单七状态、操作编码、内部状态兼容映射,以及与三期一致的 `LOADED` 硬门禁和 `DELIVERED` 可信回传边界。
- [首页数据看板真实化与统计策略规划](首页数据看板真实化与统计策略规划.md):记录首页看板当前数据能力、实时/缓存边界、指标口径和后续实施顺序。
- [Admin/Client 前端原型还原验收规则](Admin-Client前端原型还原验收规则.md):已确认原型页面的逐操作承载方式、视觉还原、响应式检查和验收证据要求。
- [统一订单主状态与操作契约](统一订单主状态与操作契约.md):统一订单状态、操作编码、内部状态映射和可信履约回传边界。
- [Admin/Client 前端原型还原验收规则](Admin-Client前端原型还原验收规则.md):页面操作承载方式、视觉还原、响应式检查和验收证据要求。
- [AI 工程执行与协作约束](AI工程执行与协作约束.md):工作区、依赖、Git、部署、数据库、质量门禁和独立任务协作规则。
- [数据库中文注释维护规范](数据库注释维护规范.md):数据库注释口径、职责、迁移流程、自动门禁与实值验收要求。
- [测试环境 Jenkins 部署指南](测试环境Jenkins部署指南.md):测试环境持续部署授权、Job 参数、执行边界、健康检查与失败处理。
- `悦/`:产品原型、流程图、历史架构资料和调研数据,仅作为需求参考,不直接等同于已确认范围。
- `superpowers/`:具体功能的设计与实施记录,按日期和主题维护。
- [测试环境 Jenkins 部署指南](测试环境Jenkins部署指南.md):测试环境持续部署授权、Job 参数、健康检查与失败处理。
- [阿里云生产环境选型、压测与上线手册](阿里云生产环境选型压测与上线手册.md):ECS/ALB、RDS MySQL、Redis、OSS、Nacos、RocketMQ、压测、高可用、监控、备份与上线清单。
- [首页数据看板真实化与统计策略规划](首页数据看板真实化与统计策略规划.md):首页指标、实时与缓存边界、统计口径和实施顺序。
- [墨家设备测量上传接口说明 V3](墨家设备测量上传接口说明-V3.md):测量设备经 Gateway 上传箱码、尺寸、重量和图片的接口契约。
## 环境协作
- [开发环境独立任务协作登记](开发环境独立任务协作登记.md):开发环境全流程总控与长期专项的稳定任务、职责及开发数据库/部署/HTTP 授权。
- [测试环境独立任务协作登记](独立任务协作登记.md):测试环境系统总控与长期专项的稳定任务、职责和测试数据库授权。
## 参考资料
- `悦/`:产品原型、流程图、历史架构资料和调研数据,只作为需求参考,不直接定义当前范围。
- `superpowers/`:按日期和主题保留的具体功能设计与实施记录。
## 维护规则
- 只影响单个阶段的范围、进度和验收文档放入对应阶段目录。
- 公共架构、跨阶段契约和长期产品资料保留在 `docs/` 根目录或独立专题目录。
- 阶段范围变化时同步更新该阶段的规划、进度表及受影响的公共契约。
- 原型中出现的功能不自动进入开发范围,必须在阶段规划中明确优先级、依赖和验收标准。
- 新文档按业务域归档,不新增以开发批次编号命名的目录、文件、标题、任务或范围标签。
- 当前交付范围始终按端到端全流程理解;业务域目录只用于检索和职责归属,不用于排除上下游流程。
- 范围、字段或流程冲突时,按“当前对话确认 > 正式契约与确认记录 > 项目指引与代码 > 原型 > 历史记录”判断。
- 新增或修改业务能力时,同步更新业务域 README、跨端契约、接口、权限、SQL、测试和验收入口。
- 原型中出现的功能不自动成为有效实现;必须由正式契约、代码和验收证据共同确认。