admin
56665283aa
- 新增前端交互状态机文档，梳理全局状态、工作区工具、语义分类树、键盘快捷键、范围选择、AI页、模板确认和导入导出交互。 - 明确记录 Esc 行为：只取消当前 mask 选区和临时绘制状态，不删除已有 mask，也不清空 active class。 - 补充 CanvasArea 测试，覆盖 Esc 取消选中 mask 但保留 mask/active class，以及 Esc 取消进行中的多边形绘制。 - 更新文档索引、AGENTS 和测试计划，把前端交互状态机纳入事实文档和 R13 文档测试覆盖。
35 lines
2.5 KiB
Markdown
35 lines
2.5 KiB
Markdown
# 项目文档索引
|
||
|
||
本目录用于记录当前代码库的真实状态、目标设计与实现差距。文档依据包括：
|
||
|
||
- 根目录 Word 文档：`语义分割系统构建方案.docx`
|
||
- 前端源码：`src/App.tsx`、`src/components/*.tsx`、`src/lib/api.ts`、`src/store/useStore.ts`
|
||
- 后端源码：`backend/main.py`、`backend/routers/*.py`、`backend/schemas.py`、`backend/models.py`
|
||
- 运行时 OpenAPI：`http://localhost:8000/openapi.json`
|
||
|
||
## 文档结构
|
||
|
||
| 文档 | 内容 |
|
||
|------|------|
|
||
| [01-purpose-and-word-summary.md](./01-purpose-and-word-summary.md) | 为什么要做这个系统，Word 方案中的目标，以及当前代码的落地程度 |
|
||
| [02-current-implementation-map.md](./02-current-implementation-map.md) | 当前系统怎么运行，前后端、存储、数据流具体怎么串起来 |
|
||
| [03-frontend-element-audit.md](./03-frontend-element-audit.md) | 前端逐页面/逐元素审计：真实可用、半可用、Mock/UI-only、接口不通 |
|
||
| [04-api-contracts.md](./04-api-contracts.md) | 前端 API 封装、后端 FastAPI 接口、已完成对齐项和剩余接口问题 |
|
||
| [05-implementation-plan.md](./05-implementation-plan.md) | 后续要把 Mock 变成真实功能的建议实施顺序 |
|
||
| [06-fastapi-docs-explained.md](./06-fastapi-docs-explained.md) | `http://192.168.3.11:8000/docs` 是什么，怎么看和怎么用 |
|
||
| [07-current-requirements-freeze.md](./07-current-requirements-freeze.md) | 当前版本需求冻结，测试以此为准 |
|
||
| [08-current-design-freeze.md](./08-current-design-freeze.md) | 当前版本设计冻结，记录模块、数据流和接口边界 |
|
||
| [09-test-plan.md](./09-test-plan.md) | 需求到测试文件的覆盖矩阵和运行命令 |
|
||
| [10-installation.md](./10-installation.md) | 系统安装部署指南，覆盖 PostgreSQL、Redis、MinIO、后端、Celery、前端和 SAM 2.1 权重 |
|
||
| [11-frontend-interaction-state-machines.md](./11-frontend-interaction-state-machines.md) | 前端 UI 交互细节、键盘规则、工具/范围/确认弹窗状态机和对应测试 |
|
||
|
||
## 状态标记
|
||
|
||
| 标记 | 含义 |
|
||
|------|------|
|
||
| 真实可用 | 已接真实前端状态或后端 API，按当前代码能完成主要动作 |
|
||
| 部分可用 | 有真实数据或真实 UI，但存在关键缺口，例如只读、不能持久化、缺少错误处理 |
|
||
| Mock / UI-only | 只有展示或本地状态变化，没有真实业务效果 |
|
||
| 接口不通 | 前端调用和后端接口契约不一致，按当前代码大概率失败 |
|
||
| 目标设计 | Word 方案中提出，但当前代码尚未实现 |
|