docs: define requirements

This commit is contained in:
shen 2026-05-21 20:35:51 +08:00
parent 46a594a137
commit 26e6a1c94f

51
.planning/REQUIREMENTS.md Normal file
View File

@ -0,0 +1,51 @@
# 需求ReadViewSDK
**定义日期:** 2026-05-21
**核心价值:** 稳定可用的 EPUB/TXT 阅读体验
## v1 需求(本次范围)
### 渲染Reflowable EPUB
- [ ] **REND-01**reflowable EPUB 的正文渲染/排版/分页改为参考 `Doc/WXRead/` 的“微信读书WXRead渲染方式”不再依赖现有 reflowable 的 `WKWebView` 渲染路径
- [ ] **REND-02**Fixed Layout EPUB 与交互式 EPUB 继续使用 `WKWebView`,行为不因本次改造产生回归
- [ ] **REND-03**reflowable EPUB 新旧渲染切换具备清晰的判定条件(例如:固定版式/交互式走 `WKWebView`;普通正文走原生渲染),且可通过 Demo 明确验证
### 稳定性(回归保障)
- [ ] **STAB-01**:不破坏现有“通过 `RDURLReaderController` 打开 `.epub` / `.txt` 并进入阅读器”的主流程
- [ ] **STAB-02**:改造后的 reflowable EPUB 在常见内容(图片、基础 CSS、段落/标题、链接等)下渲染稳定,不出现崩溃/白屏/无限加载等关键问题
## v2 需求(延期)
### 功能扩展(暂不进入本次路线图)
- **PERF-01**:定义并达成明确的性能指标(首屏、翻页耗时、内存峰值)与持续监控方案
- **QA-01**:补齐系统化的自动化测试矩阵(渲染对齐、分页一致性、回归用例集合)
## 不做(防止范围漂移)
| 功能 | 原因 |
|---|---|
| Fixed Layout EPUB 切换到原生渲染 | 本次明确保留 `WKWebView` 路径以控制风险 |
| 交互式 EPUB 切换到原生渲染 | 交互能力JS/音视频/表单/iframe/外链/bridge更适配 `WKWebView`,本次不改 |
| 除 reflowable EPUB 渲染改造外的大范围功能/交互/持久化重做 | 控制改动半径,聚焦核心渲染替换 |
## 可追溯性(需求 ↔ Phase
| 需求 | Phase | 状态 |
|---|---:|---|
| REND-01 | Phase 2 | Pending |
| REND-02 | Phase 1 | Pending |
| REND-03 | Phase 2 | Pending |
| STAB-01 | Phase 3 | Pending |
| STAB-02 | Phase 3 | Pending |
**覆盖统计:**
- v1 需求总数5
- 已映射到 phases5
- 未映射0 ✓
---
*Requirements defined: 2026-05-21*
*Last updated: 2026-05-21 after initial definition*