lixu
54175238ad
新增 docs/planning/ 规划文档归档: - 00-final-plan: 最终规划(决策+架构+M0~M5任务清单) - 01-detailed-design-v2.0: 分类/单位/数据库/API/治理/采集/部署/众包 - 02-advanced-topics-v3.0: OpenAPI/全表DDL/数据契约/OFF映射/中国合规/测试/安全/图片/SLA/竞品 - history/: v0.1~v1.0 演进记录 更新 README 为项目介绍并链接规划文档。 Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
41 lines
2.3 KiB
Markdown
41 lines
2.3 KiB
Markdown
# 天工·商品标签 (OpenGoods) — 规划文档归档
|
||
|
||
本目录归档了项目从立项到方案定稿的全部规划文档。
|
||
|
||
## 项目一句话
|
||
公益网站/服务：**采集全网商品信息，对外提供商品参数查询 API**。
|
||
核心原则：**只采集 + 只提供信息，绝不涉及任何购买/下单/比价导购。**
|
||
|
||
## 当前文档（最新，建议优先阅读）
|
||
|
||
| 文档 | 内容 |
|
||
|------|------|
|
||
| [00-final-plan.md](./00-final-plan.md) | **最终规划**：锁定的全部决策 + 架构 + 仓库结构 + M0~M5 可执行任务清单 |
|
||
| [01-detailed-design-v2.0.md](./01-detailed-design-v2.0.md) | **详细设计**：商品分类体系(GS1 GPC)、单位管理、数据库设计、API 契约、数据治理、采集合规、部署运维、众包、里程碑估算 |
|
||
| [02-advanced-topics-v3.0.md](./02-advanced-topics-v3.0.md) | **进阶专题**：完整 OpenAPI、全表 DDL、数据契约、OFF 字段映射、中国合规专项、测试、安全反滥用、图片处理、SLA、竞品分析 |
|
||
|
||
## 演进历史（History）
|
||
|
||
| 文档 | 阶段 |
|
||
|------|------|
|
||
| [history/v0.1-initial-plan.md](./history/v0.1-initial-plan.md) | 初版总体规划 |
|
||
| [history/v0.2-go-python-foodfmcg.md](./history/v0.2-go-python-foodfmcg.md) | 确定 Go+Python 架构、聚焦食品快消、数据源调研 |
|
||
| [history/v1.0-locked-decisions.md](./history/v1.0-locked-decisions.md) | 决策定稿（默认值） |
|
||
|
||
## 已锁定的关键决策（速览）
|
||
|
||
| 维度 | 决策 |
|
||
|------|------|
|
||
| 首批品类 | 食品快消 |
|
||
| 价格 | 只收官方标准零售价 (MSRP)，静态字段，无购买入口 |
|
||
| 技术栈 | Go（对外只读 API） + Python（采集/ETL），经 PostgreSQL + Redis/队列解耦 |
|
||
| 种子数据 | Open Food Facts 食品 dump |
|
||
| 数据许可 | 对外 ODbL + 署名；CC0 来源(USDA)自由混入 |
|
||
| 商品分类 | GS1 GPC 四层标准码 + 自建中文品类树映射 |
|
||
| 单位管理 | 原始值+归一化双存；营养统一 per_100g/ml；能量双存 kJ+kcal |
|
||
| 质量评分 | 0.4 完整度 + 0.3 来源权威 + 0.2 多源一致 + 0.1 新鲜度 |
|
||
| 众包 | 一期不做，先纯采集；二期开放 |
|
||
| Go 框架 / 迁移 / 部署 | chi + 标准库 / golang-migrate / Docker Compose |
|
||
|
||
> 注：文档中"中国合规专项"为工程与运营层面梳理，**非法律意见**；正式上线前请咨询专业法务。
|