Files
MinerU/docs/next
..
2026-07-08 18:57:34 +08:00
2026-07-08 16:59:37 +08:00
2026-06-16 13:38:41 +08:00
2026-07-21 12:28:30 +08:00
2026-07-21 12:28:30 +08:00
2026-07-08 16:59:37 +08:00

Next MinerU 文档体系

状态: Draft 读者: 项目核心开发者、SDK/API 设计参与者、需要理解下一代能力边界的外部开发者 范围: 组织下一阶段 MinerU 的产品方向、系统架构、公开接口和关键内部规范 非目标: 立即改写现有正式用户文档

文档定位

docs/next/ 是下一代 MinerU 设计文档的体系化入口。根目录旧 NEXT-*.md 底稿中的信息已按主题迁移到本目录;本目录负责建立导航、边界和读者路径。

当前阶段的事实来源是本目录专题文档和仓库代码。后续当某个主题完成审阅后,可以把对应文档从 Draft 提升为稳定设计文档。

推荐阅读顺序

  1. 产品路线图: 先理解产品定位、边界和优先级。
  2. 术语表: 统一 tier、backend、parser、doclib 和 parse-server 等核心词。
  3. 端到端工作流: 串起 watch、ingest、parse、cache、search、API、SDK 和 Agent 读取流程。
  4. 实现计划: 面向编程 Agent 的细粒度任务拆分、边界和验收。
  5. 系统架构: 再理解本地文档库、服务、任务和存储模型。
  6. 解析 Tier: 理解默认选择、flashbasicstandardadvanced 的质量、速度、硬件和隐私边界。
  7. CLI 规格: 理解本地入口和批处理体验。
  8. Unified API: 理解云端和自部署 API 的统一模型。
  9. SDK 设计: 理解 Tool SDK 与 Product SDK 的分层。
  10. Middle JSON: 理解跨 backend 的中间结构统一方向。
  11. 页码命名约定: 统一 page_rangepagespage_idxpage_nopage_count
  12. 错误码体系: 理解错误响应和本地错误分类。
  13. 配置体系: 收敛本地、远端和解析参数的配置规则。
  14. Telemetry 设计: 理解匿名使用统计、稳定性指标和粗粒度环境画像。
  15. 开放问题清单: 查看仍未定稿、需要进一步决策的问题。
  16. 设计决策记录: 查看已定稿的关键决策。

文档地图

主题 新文档 底稿 主要读者
产品路线 roadmap.md 已迁移,当前专题文档已核对 产品、核心开发
术语统一 glossary.md 用户讨论 / 各底稿 核心开发、文档作者、SDK/API/CLI 设计参与者
端到端工作流 workflows.md 用户讨论 / 各专题文档 核心开发、Agent 能力开发、SDK/API/CLI 设计参与者
实现计划 implementation-plan.md docs/next/ 全部专题文档 编程 Agent、核心开发、代码审查者
系统架构 architecture.md 已迁移,当前代码已核对 核心开发
解析 Tier tiers.md 用户讨论 / 旧路线图、旧 CLI 与旧设计底稿迁移内容 CLI/API/SDK 使用者、核心开发
Unified API api.mdapi/ 已迁移;修订记录和历史接口对比未迁移 API 使用者、服务端开发
CLI cli.md 已迁移,当前代码已核对 CLI 用户、核心开发
SDK sdk.mdsdk/ 已迁移 SDK 使用者、核心开发
Middle JSON middle-json.mdmiddle-json/ 已迁移,当前代码已核对 backend 开发、内容输出开发、Agent 能力开发
页码命名 page-naming.md 用户讨论 / 代码约定 核心开发、编程 Agent、SDK/API/CLI 设计参与者
错误码 errors.md 已迁移 API/CLI/SDK 开发
配置 config.md 配置专题文档仍待继续核对 CLI、服务端、SDK 开发
Telemetry telemetry.md 用户讨论 / 旧路线图底稿迁移内容 产品、核心开发、数据分析、合规参与者
开放问题 open-questions.md 各专题文档、用户讨论 核心开发、编程 Agent、文档维护者

整理原则

  • 先集中信息来源,再逐步提升为稳定文档。
  • 每篇文档只回答一个层级的问题,避免路线图、规格和实现细节互相混杂。
  • 对外接口文档优先描述可观察行为;内部设计文档优先描述模块职责、数据流和约束。
  • 已决定的内容进入正文;未决定的内容集中放在 开放问题清单
  • 重大选择进入 decisions/,避免在长文中丢失决策背景。