# leaudit-platform 文档地图

> 最后更新：2026-05-09
> 当前已按“业务模块 / 专题模块”重组 `docs/` 目录，根目录只保留总导航与总交接文档。

## 根目录只看这两份

- `docs/HANDOFF.md`：当前真实状态、已完成事项、剩余阻塞、关键代码位置
- `docs/README.md`：模块化文档导航

## 现在的模块目录

| 模块 | 目录 | 主要内容 |
|---|---|---|
| 项目总览 / 协作 | `docs/项目总览/` | Git 协作规范、项目级补充资料 |
| 文档管理 | `docs/文档管理/` | 文档上传、列表、详情、评查触发 |
| 入口模块 | `docs/入口模块/` | 首页入口、入口模块绑定、模块归属 |
| 评查点分组 | `docs/评查点分组/` | 一级分组、二级分组、规则集迁移方案 |
| 系统使用统计 | `docs/系统使用统计/` | 需求、表设计、接口设计、任务拆解 |
| 权限与地区隔离 | `docs/权限与地区隔离/` | RBAC、权限点、地区隔离、初始化 SQL |
| RAG | `docs/RAG/` | RAG 聊天接口、RAG 上线清单 |
| 交叉评查 | `docs/交叉评查/` | 交叉评查业务方案、表结构、流程图 |
| 规则编辑 | `docs/规则编辑/` | YAML 规则、Bridge 接入、规则链实施计划 |
| LeAudit 架构 | `docs/leaudit/` | 核心表结构、Bridge、处理流水线、AuditCtx |
| 迁移与兼容 | `docs/迁移与兼容/` | 老用户迁移、历史 API / 权限文档索引、旧导航 |

## 推荐阅读顺序

### 1. 快速了解当前项目

1. `docs/HANDOFF.md`
2. `docs/文档管理/文档上传与列表接口分析.md`
3. `docs/权限与地区隔离/权限与地区隔离文档导航.md`

### 2. 新人接手开发

1. `docs/HANDOFF.md`
2. `docs/README.md`
3. 按业务进入对应模块目录
4. 如涉及底层链路，再看 `docs/leaudit/README.md`
5. 如涉及规则执行，再看 `docs/规则编辑/README.md`

### 3. 按事情找文档

| 你要做的事 | 先看哪份 | 再看哪份 |
|---|---|---|
| 查文档上传、文档列表、详情、评查触发 | `docs/文档管理/文档上传与列表接口分析.md` | `docs/HANDOFF.md` |
| 查首页入口、入口模块绑定 | `docs/入口模块/入口模块绑定最终设计方案.md` | `docs/HANDOFF.md` |
| 查评查点分组、文档类型、规则集迁移 | `docs/评查点分组/评查点分组目标结构与迁移方案.md` | `docs/评查点分组/评查点分组迁移执行前检查清单.md` |
| 查系统使用统计 | `docs/系统使用统计/系统使用统计最终需求.md` | `docs/系统使用统计/系统使用统计接口设计.md` |
| 查权限、角色、地区隔离 | `docs/权限与地区隔离/权限与地区隔离文档导航.md` | `docs/权限与地区隔离/用户权限与权限点清单.md` |
| 查 RAG 聊天接口 | `docs/RAG/RAG聊天接口.md` | `docs/RAG/RAG后端上线清单.md` |
| 查交叉评查业务 | `docs/交叉评查/新项目交叉评查详细业务逻辑定稿.md` | `docs/交叉评查/新项目交叉评查新表结构与接口清单.md` |
| 查规则链、YAML、Bridge 接入 | `docs/规则编辑/README.md` | `docs/规则编辑/统一OSS与规则管理实施计划.md` |
| 查 LeAudit 核心链路和表结构 | `docs/leaudit/README.md` | `docs/leaudit/document_schema_design.md` |
| 查老系统迁移 / 历史资料 | `docs/迁移与兼容/老用户迁移脚本说明.md` | `docs/迁移与兼容/历史API与权限文档索引.md` |

## 当前维护规则

- 根目录不再堆放零散专题文档
- 新文档优先放进对应模块目录
- 项目状态变化，优先更新 `docs/HANDOFF.md`
- 模块实现变化，优先更新对应模块目录下的主文档
- 历史参考、兼容说明、旧阶段索引统一放 `docs/迁移与兼容/`
- 带 `(1)`、`副本`、`最终版2` 这类文件名不再新增