Add initial reference document in Word format with structured headings and content

This commit is contained in:
Guangfei.Zhao
2026-08-24 18:46:37 +08:00
parent 70c5cef4e1
commit d43d33c3cd
197 changed files with 9230 additions and 3754 deletions
+26 -3
View File
@@ -49,7 +49,8 @@ Flutter APP 的分包、分层、技术选型等决策记录,按序号阅读
| 文档 | 内容 |
| --- | --- |
| [prd/Continental-Retail-APP-PRD.md](./prd/Continental-Retail-APP-PRD.md) | Continental Retail APP PRD V1.0 —— 19 个模块、195 条编号需求、173 张图、42。需求描述与编号需求以文本书写(表格只用于字段清单、矩阵与统计)。**自包含文档**,不引用本仓库其它 md,可直接转 Word |
| [prd/Continental-Retail-APP-PRD.md](./prd/Continental-Retail-APP-PRD.md) | Continental Retail APP PRD V1.1 —— 19 个模块、296 条编号需求、173 张图、44正文表格。第 4 章的 167 张图每张均配有四段式说明。需求描述与编号需求以文本书写(表格只用于字段清单、矩阵与统计)。**自包含文档**,不引用本仓库其它 md,可直接转 Word |
| [prd/modules/](./prd/modules/README.md) | PRD 第 4 章的 14 个业务模块拆分件,每模块一个文件:正文 4.x + **逐张配图的四段式说明**(页面内容 / 关键交互 / 可用角色 / 需求关联)+ 从 10.2、附录 A/B/C 归拢的本模块分片。**第 4 章的编辑入口,需求变更改这里**;主文件第 4 章是回灌产物,勿直接编辑。14 个模块**已全部建成**,167 张图逐张核看后写了说明;逐图核对使第 4 章需求从 121 条增至 222 条、待确认从 74 条增至 121 条,**已于 2026-08 回灌主文件**V1.1 |
同目录下的 `images/`(自 `origin-prd` 抢救的 F6 与后台原型图)、`app-design-images/`(设计稿)、`mini-program-images/{O2O,ROOS,Warranty}/`(现状小程序截图)为其图源。
@@ -57,13 +58,35 @@ Flutter APP 的分包、分层、技术选型等决策记录,按序号阅读
| 文档 | 性质 | 是否可作需求依据 |
| --- | --- | --- |
| `prd/Continental-Retail-APP-PRD.md` | **V1.0,现行版本** | ✅ 是 |
| `prd/Continental-Retail-APP-PRD.md` | **V1.1,现行版本** | ✅ 是(第 4 章的编辑入口在 `prd/modules/` |
| `origin-prd/Conti Retail APP需求分析文档.md` | V0.9,业务侧编制的原始需求,V1.0 的主线来源,保留存档 | ✅ 是(V1.0 已全量归位) |
| `Architecture-Diagram/202606-Continental-Retail-APP-PRD.md` | 前期架构梳理阶段的草稿,**其需求陈述非真实需求** | ❌ **否**,仅可参考文档写法 |
V1.0 相对 V0.9 的主要变化:修复第 4 章编号断裂、将「我的」从采购下剥离为一级模块、补齐库存 / 财务对账 / 返利 / 经营业绩 / 营销会员 / 福利兑换六个缺失模块、新增系统集成与架构边界 / 非功能需求 / 验收标准 / 风险清单四章、新增权限矩阵与需求追溯矩阵。
其中 **97 条需求仍待业务确认**,集中在 PRD 第 10 章;本 README「跨文档的阻塞项」也已并入 PRD 第 10.3 节。
V1.1 相对 V1.0 的主要变化:第 4 章拆分到 [`prd/modules/`](./prd/modules/README.md) 并逐张核看 167 张配图,为每张图补写四段式说明;据此补录 V1.0 未记的机制与口径冲突,**第 4 章需求 121 → 222 条、待确认 74 → 121 条**,全文需求 195 → 296 条、待确认 97 → 144 条;修正 FIN / MKT / STM 三处 REQ 编号错位(10.2 各行标注原编号以便追溯);同步更新头部规模声明、附录 B / C / D.2 与第 10.2 节。
其中 **144 条需求仍待业务确认**,集中在 PRD 第 10 章;本 README「跨文档的阻塞项」也已并入 PRD 第 10.3 节。
### scripts/
| 脚本 | 用途 |
| --- | --- |
| [scripts/build_prd.py](./scripts/build_prd.py) | PRD 构建脚本,三个子命令:`backfill``prd/modules/` 的 14 个模块回灌进主文件第 4 章并重算派生数据、`verify` 跑 7 项一致性校验、`export` 压缩配图并出 Word |
| `scripts/reference.docx` | Word 版式模板,首次 `export` 时自动生成(东亚字体钉为标题「微软雅黑」/ 正文「等线」)。已存在则原样使用,可用 Word 直接调样式 |
必须用仓库根目录的 `.venv`(自带 pandoc 与 Pillow,系统 Python 缺依赖):
```bash
.venv/Scripts/python.exe scripts/build_prd.py verify # 只校验,不改文件
.venv/Scripts/python.exe scripts/build_prd.py backfill --dry-run # 预览回灌差异
.venv/Scripts/python.exe scripts/build_prd.py backfill # 回灌,末尾自动跑 verify
.venv/Scripts/python.exe scripts/build_prd.py export # 压缩配图 + 出 docx
```
`export` 做两件事:把 `prd/` 下三个图源目录的 PNG **就地**调色板量化(首次跑:**23.4 MB → 9.7 MB**,已量化的会跳过,日后新加的截图会自动压掉),再用 pandoc 生成 `prd/Continental-Retail-APP-PRD.docx`(约 9.8 MB,含全部 173 张图与三级目录)。**PDF 不由脚本生成**——pandoc 转 PDF 要 LaTeX,用 Word 打开 docx 另存。
> 量化是有损的(256 色)。这批截图是扁平 UI 图,实测中位 RMS 误差 0.82/255、最差 3.10,肉眼看不出差别。**原图都在 git 历史里**,要取回某张跑 `git checkout <commit> -- prd/xxx.png`。
### backend/