89 lines
11 KiB
Markdown
89 lines
11 KiB
Markdown
# 虫虫出海文档索引
|
||
|
||
项目交付文档按业务域组织。当前只有测试环境，以端到端全流程为统一范围；历史规划、确认和验收记录保留在对应业务域目录，仅用于追溯决策，不构成功能边界。
|
||
|
||
- [测试环境单机部署与配置契约](测试环境单机部署与配置契约.md)：唯一环境、部署配置、整体切换与验收。
|
||
- [统一认证与服务通信契约](统一认证与服务通信契约.md)：统一入口、权限撤销、逐事件投递与幂等。
|
||
|
||
## 业务域文档
|
||
|
||
- [业务快速索引](业务快速索引.md)：按关键词检索跨端代码入口与业务边界；含独立的按需原型入口表。先查根 AGENTS.md 短路由，只读命中行。
|
||
- 终端业务细则：[Admin](../apps/admin-web/docs/business-index.md)、[Client](../apps/client-web/docs/business-index.md)、[海外 PDA](../apps/pda-overseas-uniapp/docs/business-index.md)；先从各应用 AGENTS.md 短表定位，行为变更再核对受影响条款。
|
||
|
||
- [订单与客户](订单与客户/README.md)：登录认证、客户与企业、权限、头程订单和客户工作台。
|
||
- [入库测量与计费](入库测量与计费/README.md)：预约取货、到仓收货、箱码与箱唛、测量、尺寸策略、计价和入库费用。
|
||
- [Firstleg 按需业务索引](../baiyue-firstleg/firstleg/docs/business-index.md)：服务代码入口及测量、计价、装柜、PDA 资源结算细则；先读服务 AGENTS，再查受影响条款。
|
||
- [国内货柜履约](国内货柜履约/README.md)：分柜与同柜、智能排柜、订舱、拖车、PDA 拣货、装柜、报关和国内出仓。
|
||
- [船期日历功能规划](国内货柜履约/船期日历功能规划.md)：渠道、周模板、单次船期、收货截止时间和按渠道货量统计的独立日历规划。
|
||
- [海外仓业务](海外仓业务/README.md)：船节点、海外接柜、入仓、库存、托盘、换标、转运、废弃、退货、排车、PDA 出库、派送、异常退回、客户回访、一件代发及海外本土业务。
|
||
- [Lastleg 按需业务索引](../baiyue-firstleg/lastleg-service/docs/business-index.md)：服务代码入口及事件、查询、履约约束；先读服务 AGENTS，再查受影响条款。
|
||
- [排车列表统一作业改造契约](海外仓业务/排车列表统一作业改造契约.md)：五阶段排车、一单一趟、跨客户同车、派送安排及四块排车详情的当前改造入口。
|
||
- [排车流程修复规划](海外仓业务/排车流程修复规划.md)：取消释放、派送状态、换标全托、合托来源和前端草稿的修复边界、分工及回归要求。
|
||
- [采购订单样品履约流程变更需求](海外仓业务/采购订单样品履约流程变更需求.md)：采购样品购买、装箱、面单、交寄、国内核费与寄客户的变更入口。
|
||
- [船节点标准化契约](海外仓业务/船节点标准化契约.md)：统一船司原始状态、标准节点、预计/实际时间、异常事实、还柜停止规则和新增船司接入门禁。
|
||
- [美国预约管理统一总览与优化方案](海外仓业务/美国预约管理统一总览与优化方案.md)：美国段各类预约的范围、关联关系、表单精简及分步实施建议。
|
||
- [预约工作日历 V13 变更说明](海外仓业务/预约工作日历V13变更说明.md)：多客户共车、分批后送、改期取消、重新预约和未定日期跟进的正式业务规则与验收场景。
|
||
- [预约工作日历开发协作契约](海外仓业务/预约工作日历开发协作契约.md)：工作日历与完整待办的接口、数据归属和开发文件边界。
|
||
- [预约送仓](海外仓业务/README.md#预约送仓)：预约日历与跨客户同仓预约入口。
|
||
- [车辆管理原型梳理与任务规划](海外仓业务/车辆管理原型梳理与任务规划.md)：司机资质、车次、自有/外接承运、运维与报价的范围及契约入口。
|
||
- [内部拼车需求池首版开发契约](海外仓业务/内部拼车需求池首版开发契约.md)：车次余位发布、销售意向、承运占位、本土订单关联及我仓上车流程。
|
||
- [财务管理](财务管理/README.md)：应收、应付、费用池、账单、收款、成本、核销、凭证以及国内外业务费用来源。
|
||
- [自营业务](自营业务/README.md)：平台自营经营总览图表、SKU 销量、分仓产品库存、库存周转视图与数据采集；Admin 入口 `apps/admin-web/src/modules/self-operated/AGENTS.md`，业务设计、采集页面与进度图、查询性能优化及领星 API 联调依据见该业务域入口。
|
||
- [打印标签维护](打印标签维护/README.md)：箱唛、各类托盘标、HOLD、BOL 与其他单据的现状盘点、参考样张和逐项改版记录。
|
||
|
||
## 全流程公共契约
|
||
|
||
### 当前流程入口（收尾变更只看这里）
|
||
|
||
- [头程到尾程当前维护入口](头程到尾程/README.md)：集中进入总览、六个阶段、货柜入口、报关专题，以及页面和需求参考。
|
||
|
||
### 历史与参考（保留，不作为日常流程入口）
|
||
|
||
- [头程到尾程历史文档](归档/头程到尾程/README.md)：全流程操作手册、旧现状全景、AI 上下文和易用性方案。
|
||
- [国内货柜履约历史记录](国内货柜履约/归档/README.md)：开发规划、进度、门禁、验收矩阵、审计和旧确认材料。
|
||
|
||
以上文件继续保留，分别用于历史现状、操作说明和方案追溯；开发规划、进度、门禁和验收记录也按业务域保留，不再与当前节点总表同步改写。
|
||
- [跨区域认证与服务通信契约](跨区域认证与服务通信契约.md)：统一账号、国内/海外 Token、双区域 API、JWKS、Outbox/Inbox 与服务身份边界。
|
||
- [双区域部署与 Nacos 规划](双区域部署与Nacos规划.md)：开发/测试同机共置、生产国内/海外独立控制面、Nacos、数据库及 Event Bridge 部署边界。
|
||
|
||
### 通用规则与专项入口
|
||
|
||
- [平台、客户层级与权限契约](平台客户层级与权限契约.md)：平台/客户两级产品语义、列表包含详情的只读权限和跨层同步要求。
|
||
- [统一订单主状态与操作契约](统一订单主状态与操作契约.md)：统一订单状态、操作编码、内部状态映射和可信履约回传边界。
|
||
- [Admin/Client 前端原型还原验收规则](Admin-Client前端原型还原验收规则.md)：页面操作承载方式、视觉还原、响应式检查和验收证据要求。
|
||
- [Admin 高密度界面规范](Admin高密度界面规范.md)：已确认订单样板的字号、间距、表格、描述表和彩色页签规则；[统一弹窗规范](Admin高密度界面规范.md#弹框与表单)维护所有 Admin 弹窗的目标风格、尺寸分类和分模块实施入口。
|
||
- [Admin 客户管理样式核对记录](Admin客户管理样式核对记录.md)：客户列表、海外仓阶梯费用及关联详情和弹框的样式与人工验收项。
|
||
- [Admin 国内仓样式核对记录](Admin国内仓样式核对记录.md)：7 个菜单、关联详情与浮层的范围、样式复核和验收证据。
|
||
- [Admin 货柜管理样式核对记录](Admin货柜管理样式核对记录.md)：订舱、拖车、送柜报关、清关提柜入口及共享组件边界。
|
||
- [Admin 海外仓样式核对记录](Admin海外仓样式核对记录.md)：海外仓 10 个菜单、独立详情、作业弹框和共享组件显式接入边界。
|
||
- [AI 工程执行与协作约束](AI工程执行与协作约束.md)：工作区、依赖、Git、部署、数据库、质量门禁、本机多对话重型检查限流和独立任务协作规则。
|
||
- [数据库中文注释维护规范](数据库注释维护规范.md)：数据库注释口径、职责、迁移流程、自动门禁与实值验收要求。
|
||
- [数据库版本迁移与 Jenkins 自动发布方案](数据库版本迁移与Jenkins自动发布方案.md)：两人团队自动迁移规划；统一工具入口、自动编号、开发/测试/生产执行分工、单服务迁移范围、漏写迁移检查、Flyway 校验、失败候选修订、发布证据保留、带数据升级演练及实施顺序。
|
||
- [数据库迁移操作手册](../baiyue-firstleg/deploy/sql/数据库迁移操作手册.md)：开发者和发布执行人日常使用说明；包含新建、检查、生成清单、测试执行、生产晋级、失败处理和维护规则。
|
||
- [生产服务监控告警与无停机发布方案](生产服务监控告警与无停机发布方案.md)：容器与外部可用性监控、部署期告警处理、自动恢复、发布通知及滚动/蓝绿发布演进方案。
|
||
- [测试环境 Jenkins 部署指南](测试环境Jenkins部署指南.md)：测试环境持续部署授权、Job 参数、健康检查与失败处理。
|
||
- [阿里云生产环境选型、压测与上线手册](阿里云生产环境选型压测与上线手册.md)：ECS/ALB、RDS MySQL、Redis、OSS、Nacos、RocketMQ、压测、高可用、监控、备份与上线清单。
|
||
- [阿里云 OSS 文件中心接入设计与评审](阿里云OSS文件中心接入设计与评审.md)：Admin、Client、国内/海外 PDA 文件接入 OSS 的区域拓扑、存储适配、权限、一致性、实施拆分、验收门禁和方案评审。
|
||
- [首页数据看板真实化与统计策略规划](首页数据看板真实化与统计策略规划.md)：首页指标、实时与缓存边界、统计口径和实施顺序。
|
||
- [墨家设备测量上传接口说明 V3](墨家设备测量上传接口说明-V3.md)：测量设备经 Gateway 上传箱码、尺寸、重量和图片的接口契约。
|
||
|
||
## 环境协作
|
||
|
||
- [开发环境独立任务协作登记](开发环境独立任务协作登记.md)：开发环境全流程总控与长期专项的稳定任务、职责及开发数据库/部署/HTTP 授权。
|
||
- [测试环境独立任务协作登记](独立任务协作登记.md)：测试环境独立任务的稳定身份、职责和协作边界。
|
||
- [测试任务盘点与需求台账](测试任务盘点与需求台账.md)：历史任务快照、未闭环需求、提交线索和待核实证据，不作为当前调度依据。
|
||
|
||
## 参考资料
|
||
|
||
- `悦/`：产品原型、流程图、历史架构资料和调研数据，只作为需求参考，不直接定义当前范围。
|
||
- `superpowers/`：按日期和主题保留的具体功能设计与实施记录。
|
||
|
||
## 维护规则
|
||
|
||
- 新文档按业务域归档，不新增以开发批次编号命名的目录、文件、标题、任务或范围标签。
|
||
- 已完成开发阶段的流程手册、规划、进度和验收资料统一放入 `归档/`；后续流程变更只从[头程到尾程当前维护入口](头程到尾程/README.md)进入。
|
||
- 当前交付范围始终按端到端全流程理解；业务域目录只用于检索和职责归属，不用于排除上下游流程。
|
||
- 范围、字段或流程冲突时遵循根 AGENTS.md 的事实优先级；归档确认记录不覆盖当前正式契约。文档角色按当前入口和明确标记判断，不只按文件名判断。
|
||
- 业务事实变化只修改其当前主文档及实际受影响的接口、权限、SQL、代码和测试；业务域 README 与索引仅在入口或职责变化时更新。历史规划、确认和验收记录冻结，不为追随当前规则批量改写。
|
||
- 原型中出现的功能不自动成为有效实现；必须由正式契约、代码和验收证据共同确认。
|