跳转至

crawler4j

这是 crawler4j 的正式文档入口,面向第一次接触产品的人、日常使用者、现场支持、模块开发者和内部维护者。

文档按“入门说明 / 用户指南 / 开发者指南 / 项目开发文档(内)”四层组织。如果你不是在维护源码,通常只需要前两层。

四大模块

模块 回答的问题 主要读者
docs/01-getting-started/ 面向所有人的单页产品介绍:这是什么、能做什么、从哪开始读 第一次接触产品的人 / 协作者
docs/02-user-guide/ 如何安装、配置、使用 和管理宿主应用 宿主使用者 / 管理员 / 协作者
docs/03-developer-guide/ 如何开发、调试、交付模块 模块开发者 / Core 集成人员
docs/04-project-development/ 项目如何治理、设计、实施、验证、发布、运维和追踪 Tech Lead / Dev / QA / Release / Ops

按角色快速阅读

新维护者

  1. 了解 crawler4j
  2. 开始使用
  3. Core 接手与日常维护
  4. 当前真实状态分析
  5. 实施方案

模块开发者

  1. 开发者指南总览
  2. 快速开始
  3. 核心概念
  4. 模块结构
  5. 构建模块
  6. 交付模块

发布 / 运维

  1. 发布与交付概览
  2. 验收检查清单
  3. 交付包清单
  4. 部署与运行说明
  5. 运行手册

宿主使用者 / 协作者

  1. 开始使用
  2. 安装与第一次打开
  3. 首次设置
  4. 日常使用
  5. 作业详情整图说明
  6. 异常案例
  7. 管理员指南

维护规则

  • 只有根 docs/index.md 声明全站 mkdocs.nav 、页面路径和页面权限。
  • 子目录 index.md 只作为正文首页和资源权限锚 点,不再承担导航声明职责。
  • 页面、图片和附件跟随所属目录维护;资源文件放 在当前目录或当前目录的 assets/ 下。
  • 仓内链接统一使用相对路径,不写机器绝对路径。
  • 新增、删除或移动 Markdown 页面后,同步刷新根 docs/index.md 的目录树、docs/04-project-development/10-traceability/document-index.md.factory/memory/doc-map.md