docs: 建立 Admin 子项目的文档基线

仓库从单子项目变成两个:client(Python + PyQt5 桌面端)和
admin(Go + Gin + HTML 模板 Web 管理端)。两者技术栈完全不同,
规则各自独立,只通过三个 HTTP 接口交互。

新增 admin/AGENTS.md 和 docs/admin/ 共 9 份文档,结构与 docs/client/ 对齐。

关键设计决策(均已与用户确认)
- 四模块:蝦皮数据 / 顺运宝数据 / 采购任务 / 客户端列表,
  统一三段式布局(工具条 / 带勾选的表格 / 状态条)
- 蝦皮数据拆成商品表 + SKU 表:报表本身就是两层结构,
  且 PDD 链接是商品级的,放 SKU 级会重复维护
- pdd_data 存商品级,一个 PDD 商品采一次,所有订单共用
- SKU 映射独立成表且可复用,同一蝦皮 SKU 只需人工匹配一次
- PDD 链接人工填写,采集按钮就放在填链接的编辑弹窗里
- 任务分配给指定客户端;不加心跳,注册在领取时完成,
  在线状态由 last_seen_at 派生
- SQLite 驱动固定 modernc.org/sqlite(纯 Go 免 cgo,go build 直接出 exe)
- 不引入前端框架和 npm 构建,只允许原生 JS 或 htmx

基于样本文件 raw_data/蝦皮数据样本.xlsx 实测得出的约束
- 11287 行 = 5195 商品汇总行 + 6092 SKU 行,导入必须分开处理
- 商品規格ID 零重复,是天然主键
- 规格原文两种格式各占 53.4% / 46.6%,只解析【】会漏掉一半
- 平均每商品仅 1.17 个 SKU,报表不是全量目录,
  因此必须支持手动新增,且货运单外键不能加硬约束

同步更新
- 根 AGENTS.md 开头的指针改为两个子项目对照表
- docs/README.md 重构为双子项目索引
- .gitignore 加 admin/data/、admin.exe、Excel 锁文件

说明:Gitea 尚未配置,本次无对应工单号。
raw_data/ 未提交,含台币销售额等商业数据,待用户决定。

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
chengma
2026-08-06 15:49:04 +08:00
co-authored by Claude Opus 5
parent cbcfaca728
commit 90379347b4
13 changed files with 1963 additions and 29 deletions
+64
View File
@@ -0,0 +1,64 @@
# 00 Admin 术语表
- 文档状态:基线草案
- 用途:Admin 文档里出现的专业词,在这里查一句话解释
跨 Client 和 Admin 共用的词(幂等、SKU、采集任务、采购任务、便携模式……)
在 [Client 术语表](../client/00-glossary.md) 里,本文不重复。
## 1. 业务名词
| 词 | 一句话解释 | 在本项目里指 |
|---|---|---|
| 蝦皮 / Shopee | 台湾的电商平台,**我们在上面卖货** | 订单的来源。导出的报表是繁体中文、金额是台币 |
| 顺运宝 / SYB | 物流服务商,提供**货运单** | 告诉我们"这单要发什么货",是采购的触发源 |
| 货运单 | 顺运宝那边的一条发货记录 | `syb_orders` 表的一行 |
| 拼多多 / PDD | 大陆的电商平台,**我们在上面进货** | 采购的目标平台 |
| 商品規格ID | 蝦皮给每个 SKU 的唯一编号 | `shopee_skus.sku_id`。实测 6092 条零重复,是天然主键 |
| 规格原文 | 蝦皮报表里没拆开的那一列,例如 `黑色,M【建議40-50公斤】` | `shopee_skus.spec_raw`,**永远原样保留** |
| 建议 | 蝦皮规格里的建议体重,例如 `40-50公斤` | 不是"建议采购链接",别理解错 |
| SKU 映射 | "蝦皮的这个规格 = 拼多多的那个规格"的对应关系 | `sku_mappings` 表。**匹配一次,以后同商品自动带出** |
| 采集状态 | 某个蝦皮商品对应的 PDD 商品数据采到没有 | `shopee_products.collect_status` |
## 2. 技术名词
| 词 | 一句话解释 | 在本项目里指 |
|---|---|---|
| Gin | Go 的一个 Web 框架,负责把 URL 路由到你的函数 | 唯一允许使用的 Web 框架 |
| `html/template` | Go 自带的 HTML 模板引擎,**会自动转义**,防 XSS | 所有页面都用它渲染,不引入前端框架 |
| 服务端渲染 | 页面的 HTML 在服务器上拼好再发给浏览器 | 与之相对的是前端框架在浏览器里拼,本项目**不用** |
| htmx | 一个单文件 JS 库,让 HTML 标签直接发请求换局部内容 | 需要局部刷新时可用,**没有构建步骤** |
| upsert | "有就更新、没有就新增",一次操作搞定 | Excel 导入的唯一正确做法,见 §3 |
| cgo | Go 调用 C 代码的机制。**用了就需要装 C 编译器** | 本项目**避开它**,所以 SQLite 驱动选纯 Go 的 |
| `modernc.org/sqlite` | 纯 Go 实现的 SQLite,不需要 cgo | 固定用它,`go build` 直接出 exe |
| excelize | Go 读写 Excel 的库 | 固定用它读蝦皮报表 |
| CSRF | 攻击者诱导你在已登录状态下发出非本意的请求 | 所有写操作都要防,见 [06](06-quality-security.md) §4 |
| 参数化查询 | SQL 里用 `?` 占位、值单独传,而不是拼字符串 | 防 SQL 注入的唯一正确做法 |
## 3. 为什么导入必须是 upsert
这条单独说,因为**做错了会丢数据**。
蝦皮报表可以反复导入(每次导出的都是"最近有成绩的商品",不是全量)。
而 **PDD 链接是人工一条条填上去的**,只存在我们自己的库里,报表里没有。
所以导入时:
| 做法 | 后果 |
|---|---|
| 先 `DELETE` 再 `INSERT` | **人工填的 PDD 链接、SKU 映射全没了** ✗ |
| 按主键 upsert | 报表里有的字段更新,人工填的字段原样保留 ✓ |
主键:商品用 `商品ID`,SKU 用 `商品規格ID`。
## 4. 蝦皮报表的两层结构
一个文件里混了两种行,别当成一种:
| 行类型 | 判断方法 | 条数(样本) | 导入到 |
|---|---|---|---|
| 商品汇总行 | `商品規格ID` 是 `-` | 5195 | `shopee_products` |
| SKU 行 | `商品規格ID` 是数字 | 6092 | `shopee_skus` |
平均每个商品只有 1.17 个 SKU —— 因为这份报表**只包含有销售成绩的 SKU,不是完整目录**。
所以订单来了查不到 SKU 是正常现象,界面必须支持**手动新增**,见 [01 需求](01-requirements.md) §4.1。