0b76dce2a574c31fcc8d26ba7ebad25985b6fcb7
leaudit-platform 文档地图
最后整理:2026-05-04 当前主线:以后端
fastapi_leaudit的/docs为主整理入口,前端文档仅保留必要索引引用。
先看什么
- 给老板汇报当前状态:先看
docs/HANDOFF.md - 接手继续开发:先看
docs/HANDOFF.md,再看docs/接口/README.md - 查具体模块:按下面“功能模块索引”找对应文档
- 查规则引擎与后端处理链路:看
docs/leaudit/README.md与docs/规则编辑/README.md - 查前端历史对接资料:看
new_doc_review/docs/README.md - 查旧版 RBAC / API 存量资料:看
docs/历史API与权限文档索引.md
当前后端主文档
docs/HANDOFF.md:当前状态、已完成事项、下一步、关键代码位置docs/接口/README.md:后端接口文档导航docs/权限与地区隔离文档导航.md:权限、路由、地区隔离主线docs/leaudit/README.md:稳定架构、表结构、处理流水线docs/规则编辑/README.md:规则管理、Bridge 接入、落地实施顺序
功能模块索引
| 模块 | 重点文档 | 说明 |
|---|---|---|
| 全局交接 / 当前状态 | docs/HANDOFF.md |
当前主线、已完成事项、剩余阻塞、关键代码位置 |
| 后端接口总览 | docs/接口/README.md |
当前有效接口文档的阅读入口 |
| 首页入口模块 / 菜单 | docs/接口/入口模块绑定最终设计方案.md |
首页入口展示、绑定、RBAC 最小可用链路 |
| 文档上传 / 文档列表 / 文档详情 | docs/接口/文档上传与列表接口分析.md |
上传、列表、详情/更新/删除、评查触发、数据隔离 |
| 文档类型 / 规则绑定 | docs/接口/评查点分组目标结构与迁移方案.md |
文档类型、入口模块、规则组、规则集关系 |
| 评查点分组迁移 | docs/接口/评查点分组目标结构与迁移方案.md、docs/接口/评查点分组迁移执行前检查清单.md |
新老分组模型梳理与迁移脚本执行建议 |
| 权限 / 路由 / 地区隔离 | docs/权限与地区隔离文档导航.md、docs/接口/用户权限与权限点清单.md、docs/用户与地区权限完整设计方案.md |
RBAC、路由、用户与地区隔离设计 |
| 规则引擎 / OSS / Bridge | docs/规则编辑/README.md、docs/leaudit/README.md |
规则 DSL、执行链路、对象存储、Bridge 设计 |
| 历史资料索引 | docs/历史API与权限文档索引.md |
老阶段 RBAC / API 快照的使用入口 |
| 前端权限别名 | new_doc_review/docs/route-alias-guidelines.md |
什么时候加 alias,什么时候补真实菜单路由 |
文档目录约束
docs/
- 这里是当前项目的主文档目录
- 只保留当前主线设计、接口、交接、迁移、规则架构文档
- 新增业务说明优先写到这里,不要再散落到临时目录
new_doc_review/docs/
- 这里保留前端工程实现文档
- 偏实现、联调、部署、组件能力说明
- 如果某项内容已经上升为“全项目共识”,应同步沉淀回
docs/
new_doc_review/auth_doc/
- 这里以历史 API / RBAC / 前端对接资料为主
- 多数是老阶段快照,不应直接当成当前系统唯一事实来源
- 使用前先对照
docs/HANDOFF.md与docs/接口/README.md
本次已清理
- 删除重复或已被新版本覆盖的 Markdown:
docs/routes/http_routes_dedup_2026-04-27.mddocs/superpowers/plans/2026-04-28-fix-double-finalize-and-bindings-api.mddocs/用户权限开发TaskList.mddocs/leaudit/SYSTEM_OVERVIEW.mddocs/接口/新系统版_documents_list接口.mddocs/接口/首页菜单最小可用收口说明.mddocs/接口/系统设置入口恢复说明.mddocs/规则编辑/开发任务拆解清单.mddocs/规则编辑/跑通全流程所需准备项.mddocs/规则编辑/为什么仍然需要Bridge适配层.mddocs/规则编辑/yaml规则在线编辑设计.mddocs/规则编辑/worker并发执行改造方案.mddocs/leaudit/并发与重试参数说明.mddocs/接口/文档上传与评查接口.mddocs/接口/首页入口接口落地说明.mddocs/接口/评查点分组正式迁移执行建议.mddocs/接口/文档类型与评查组关联方案.mddocs/老系统_docauditai_用户权限架构深度分析.mddocs/接口/前端联调404与资源缺口收口清单.mdnew_doc_review/auth_doc/entry_modules_api(1).mdnew_doc_review/auth_doc/交叉评查接口文档(1).mdnew_doc_review/auth_doc/API_RESPONSE_EXAMPLES_V3.2.mdnew_doc_review/docs/URGENT-前端必须修改.md
- 补齐文档导航:
docs/README.mddocs/接口/README.mddocs/权限与地区隔离文档导航.mddocs/leaudit/README.mddocs/规则编辑/README.mddocs/历史API与权限文档索引.mdnew_doc_review/docs/README.md
- 统一现状入口:
docs/HANDOFF.md
后续维护规则
- 新功能如果已经进入当前主线,优先补
docs/HANDOFF.md的“已完成 / 待做” - 接口发生变化时,优先更新
docs/接口/下对应文档 - 只用于阶段排障的“临时说明”在问题关闭后要么合并进正式文档,要么删除
- 带版本号或带
(1)的副本文件,原则上不继续新增
Description
Languages
Python
89%
PLpgSQL
9.8%
Shell
0.9%
JavaScript
0.3%