# WordCloud 项目文档

本文档目录是标准文档入口。标准文档直接对应代码实现；历史/规划文档不作为行为依据。

## 标准文档

| 文档 | 用途 |
|------|------|
| [PROJECT_STANDARD.md](PROJECT_STANDARD.md) | 项目目标、目录结构、运行方式、输入输出、工程约定 |
| [ALGORITHM.md](ALGORITHM.md) | 词云生成算法：面积模型、权重、布局、C++ 碰撞搜索、高清精修 |
| [CONFIG.md](CONFIG.md) | 配置项清单、来源优先级、前端参数映射、类型校验 |
| [API.md](API.md) | FastAPI HTTP 接口、请求格式、响应结构、产物下载 |
| [CANVAS_STUDIO.md](CANVAS_STUDIO.md) | 画布设计、贴纸库、词云作为贴纸、总图 SVG 导出 |
| [TESTING.md](TESTING.md) | 单元测试、基准测试、质量门禁 |
| [DEPLOYMENT.md](DEPLOYMENT.md) | 本地开发、Docker、Ubuntu 服务器部署 |

## 非标准/历史文档

以下文档可能包含过期规划或阶段性描述，不再作为行为依据：

- `docs/PPT-EfficientWordCloud-详细大纲-v1.0.md`
- `docs/stroke-weights-optional.md`
- `backend/docs/*`
- `backend/README.md`
- `backend/README_zh.md`

## 工程约定

- **以代码为准。** 文档描述当前代码的实际行为，不提前承诺未实现能力。
- 算法事实来源：`backend/core/pipeline.py`、`backend/core/layout.py`、`backend/EfficientWordCloud/efficient_wordcloud/src/ewc_core.cpp`
- HTTP API 事实来源：`backend/service/app.py`、`backend/service/schemas.py`
- 前端事实来源：`frontend/src/App.tsx`、`frontend/src/pages/TestWorkbench.tsx`、`frontend/src/components/AdvancedPanel.tsx`、`frontend/src/types.ts`
- 变更不单独记文档；短期变更直接合并进标准文档。