WordCloud 项目文档入口
本文档目录是当前项目的标准文档入口。除非某个历史文档被明确标注为“标准文档”,否则以这里列出的文档为准。
文档准则
- 以代码为准。文档只描述当前代码实际行为,不提前承诺未实现能力。
- 以
backend/core/config.py、backend/core/pipeline.py、backend/core/layout.py、backend/EfficientWordCloud/efficient_wordcloud/src/ewc_core.cpp为算法事实来源。 - 以
backend/service/app.py、backend/service/schemas.py为 HTTP API 事实来源。 - 变更记录只记录历史,不作为使用说明。
标准文档
| 文档 | 用途 |
|---|---|
| PROJECT_STANDARD.md | 项目结构、运行方式、输入输出、工程约定 |
| ALGORITHM.md | 词云生成算法、重复填充、权重、C++ 碰撞搜索 |
| CONFIG.md | 配置项、优先级、前端参数到后端配置的映射 |
| API.md | FastAPI 接口、请求格式、响应结构、产物下载 |
| CANVAS_STUDIO.md | 画布设计、贴纸库、词云作为贴纸、总图 SVG 导出 |
非标准/历史文档
以下文档可能包含历史规划、阶段性设想或已经过期的实现描述,不再作为行为依据:
docs/PPT-EfficientWordCloud-详细大纲-v1.0.mddocs/stroke-weights-optional.mdbackend/docs/*backend/README.mdbackend/README_zh.md
需要确认行为时,优先查标准文档;标准文档仍不清楚时,直接查代码。