37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
# ReadViewSDK 文档索引
|
||
|
||
> 最后更新：2026-06-09
|
||
|
||
---
|
||
|
||
## 核心文档
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [ARCHITECTURE.md](ARCHITECTURE.md) | 系统架构总览：分层架构、核心数据流、缓存架构、目录结构、设计模式 |
|
||
| [UML_CLASS_DIAGRAMS.md](UML_CLASS_DIAGRAMS.md) | UML 类图（Mermaid 格式）：模块关系、核心类图、并发模型、缓存键设计 |
|
||
| [BUSINESS_LOGIC.md](BUSINESS_LOGIC.md) | 业务逻辑详解：EPUB 解析、文本渲染管线、后台解析优化、翻页容器、标注系统、搜索、设置 |
|
||
|
||
## 工程规范与风险
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [CONCERNS.md](CONCERNS.md) | 代码库风险与关注点：12 项安全/性能/可维护性风险 |
|
||
| [TESTING.md](TESTING.md) | 测试基础设施：UI 测试文件清单、运行方式、覆盖率 |
|
||
| [CONVENTIONS.md](CONVENTIONS.md) | 编码规范：命名约定、代码风格、导入规范、错误处理 |
|
||
| [ARCHITECTURE-CONTEXT.md](ARCHITECTURE-CONTEXT.md) | WXRead vs ReadViewSDK 架构差距分析：4 个领域、14 项决策 |
|
||
|
||
## 专题文档
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [大书后台解析优化实施清单_30秒目标.md](大书后台解析优化实施清单_30秒目标.md) | 《凡人修仙传》后台解析性能优化方案，目标从 70s 压缩到 30-50s |
|
||
|
||
## 项目信息
|
||
|
||
- **模块总数：** 4 个（EPUBCore、EPUBTextRendering、RDReaderView、EPUBUI）
|
||
- **Swift 文件数：** 139 个（SDK Sources）
|
||
- **测试用例数：** 23 个测试类，约 99 个测试方法（UI 测试）
|
||
- **最低 iOS 版本：** 15.6
|
||
- **构建方式：** CocoaPods（本地 pod）
|