docs: reorganize backend project documentation

2026-05-06 09:42:29 +08:00
parent 76ba7e65ed
commit 0d8f13ab3d
33 changed files with 2469 additions and 7407 deletions
@@ -1,29 +1,40 @@
-# 接口文档目录
+# 接口文档导航

-这个目录专门放当前 `leaudit-platform` 已落地接口的使用说明，重点记录：
+> 最后整理：2026-05-04
+> 说明：这里记录的是 `leaudit-platform` 当前主线已落地、正在联调、或明确作为迁移目标的接口文档。

- 接口用途
- 参数说明
- 业务逻辑
- 请求示例
- 返回示例
+## 阅读顺序

-当前已整理：
+1. `docs/HANDOFF.md`
+2. `文档上传与列表接口分析.md`
+3. `入口模块绑定最终设计方案.md`
+4. `用户权限与权限点清单.md`
+5. 根据具体模块继续往下看

- `文档上传与评查接口.md`
- `新系统版_documents_list接口.md`
- `用户权限与权限点清单.md`
- `用户权限初始化SQL.sql`
- `老用户迁移脚本说明.md`
- `首页入口接口落地说明.md`
- `系统设置入口恢复说明.md`
+## 按模块查找

-建议阅读顺序：
+| 模块 | 文档 | 说明 |
+|------|------|------|
+| 首页入口 / 菜单 | `入口模块绑定最终设计方案.md` | 入口模块、文档类型、规则链路绑定模型 |
+| 文档上传 / 列表 / 评查 | `文档上传与列表接口分析.md` | 上传、列表、详情、更新、删除、评查触发、数据隔离 |
+| 文档类型 / 评查组 | `评查点分组目标结构与迁移方案.md` | 文档类型、一级分组、二级分组、规则集与迁移口径 |
+| 评查点分组迁移 | `评查点分组目标结构与迁移方案.md` | 新老分组结构对齐方案 |
+| 评查点分组迁移 | `评查点分组迁移执行前检查清单.md` | 正式迁移前检查项 |
+| 权限 / 路由 | `用户权限与权限点清单.md` | RBAC、路由、权限点清单 |
+| 用户迁移 | `老用户迁移脚本说明.md` | 老用户迁移脚本与校验说明 |

-1. 先看 `文档上传与评查接口.md`
-2. 再看 `新系统版_documents_list接口.md`
-3. 再看 `用户权限与权限点清单.md`
-4. 如果要初始化角色与权限数据，再执行 `用户权限初始化SQL.sql`
-5. 如果要迁移老系统用户，再看 `老用户迁移脚本说明.md`
-6. 如果要理解 worker 并发执行，再结合 `docs/规则编辑/worker并发执行改造方案.md`
-7. 如果要理解底层数据结构，再看 `docs/leaudit/document_schema_design.md`
+## 本次归并
+
+- `新系统版_documents_list接口.md` 已并入 `文档上传与列表接口分析.md`
+- `文档上传与评查接口.md` 已并入 `文档上传与列表接口分析.md`
+- `首页入口接口落地说明.md` 已并入 `入口模块绑定最终设计方案.md`
+- `评查点分组正式迁移执行建议.md` 已并入 `评查点分组迁移执行前检查清单.md`
+- `文档类型与评查组关联方案.md` 已并入 `评查点分组目标结构与迁移方案.md`
+- `首页菜单最小可用收口说明.md`、`系统设置入口恢复说明.md` 的阶段性收口内容已并入 `docs/HANDOFF.md`
+- `前端联调404与资源缺口收口清单.md` 属于前端联调阶段记录，已从后端主文档目录移除
+
+## 使用约束
+
+- 这里的文档优先级高于 `new_doc_review/auth_doc/` 的历史快照资料
+- 如果某份文档描述和当前代码不一致，以当前代码与 `docs/HANDOFF.md` 为准，并尽快回补文档
+- 新接口如果已经用于当前主链路，必须同步补到本目录