Browse Source

docs: 操作手册改为「业务开发版」,按任务组织

原来那版是按 SDK 结构写的(创建/入参出参/能力),业务开发要先读三章
才能寄一个快递。重写为面向使用方:

一、5 分钟上手
- 引入依赖 → 实现两个 SPI(含可参考的实现)→ 组装 SDK → 拿到仓视图
- 1.4 用「查仓库清单」做连通性自检,附失败对照表

二、我要做的事能不能做
- 一张 21 行的「业务动作 × 四个仓」矩阵,先看能不能做

三、按任务(8 节,每节统一结构:代码 → 拿到什么 → ⚠️ 坑)
- 发货 / 轨迹 / 取消 / 退货 / 库存 / 商品 / 对账 / 打单

四、贯穿全局的规则
- 单位、SKU 口径、分页、金额——写一次,各任务复用

五、出错了怎么办
- 五类异常 + 重试判定 + 常见报错对照 + 幂等键表

附录:日志格式、枚举速查、更深文档去哪看

相对上一版的取舍:
- 砍掉架构分层、WarehouseContext 组装、扩展新仓等维护者视角内容
- 快速开始给完整可运行代码,任务章节给片段 + 前置说明
- IdempotencyStore 的示例改成与真实 SPI 一致(四种 Claim 结果),
  并把示意方法名标注清楚,避免被当成可直接编译的代码

Co-Authored-By: Claude <noreply@anthropic.com>
master
chenchuchuan 2 days ago
parent
commit
a7fedbe5b1
  1. 1347
      docs-warehouse/SDK操作手册.md

1347
docs-warehouse/SDK操作手册.md

File diff suppressed because it is too large Load Diff
Loading…
Cancel
Save