Stooland 项目文档中心
本目录集中管理接口文档、产品设计、架构、运维与开发约定，便于新人上手与日常查阅。
一、项目是什么
Stooland 是一个多子项目的 Monorepo，主要包含：
| 子项目 | 说明 | 技术栈 |
|---|---|---|
| api | 主后端 API（管理后台、AIGC、素材、任务等） | ThinkPHP 8 |
| web | 管理/创作前端（分镜、素材、AIGC 编排、工具） | Vue 3 + Vite + Element Plus |
| pybridge (Muse Engine) | 视频合成与 AI 处理服务（FFmpeg、智能包装、MCP） | Python FastAPI |
| social-publisher | 社交媒体自动发布工具 | Python |
核心业务线：AIGC 短视频（想法 → 分镜 → 素材/配音 → 合成 → 发布）。
二、文档结构总览
docs/
├── README.md ← 你在这里：文档中心入口
├── 00-INDEX.md ← 快速索引（按角色/任务查文档）
│
├── product/ 产品与愿景
├── architecture/ 系统架构与技术方案
├── api/ 接口规范与 OpenAPI
├── database/ 数据库约定与 ER
├── business/ 业务流程与领域说明
│
├── conventions/ 开发约定（后端/前端/运行约定）
├── web/ 前端开发与配置
├── operations/ 运维、发布与故障排查
├── adr/ 架构决策记录
│
├── agent/ 智能体设计（选题、账号规划等）
├── storyboard/ 分镜业务（开发指南、产品流程、布局与提示优化）
├── pybridge/ pybridge 专项（智能包装等）
├── social-publisher/ 社交媒体自动发布工具
├── tool/ 工具专项（Midjourney 案例视频生成器等）
├── guides/ 功能指南（AIGC/质量/FFmpeg/抖音/AutoDL 等）三、按用途快速跳转
- 新人上手：先看 00-INDEX.md 的「我是新人」。
- 跑通本地：后端
api→ api 目录；前端web→ web/README.md、web/DEVELOPMENT_CONFIG.md；分镜 Uni → storyboard/development-guide.md。 - 接口开发：conventions/backend-api-standards.md、api/README.md、api/openapi.yaml。
- 前端对接 API：conventions/frontend-api-integration.md。
- AIGC/分镜/智能体架构：architecture/README.md、architecture/aigc-agents-mcp-pybridge.md。
- 数据库与迁移：database/README.md、database/MERMAID-ER.md。
- 运维与发布：operations/README.md。
- 运行与脚本约定：conventions/trae.md。
四、各目录说明
| 目录 | 内容 |
|---|---|
| product/ | 产品愿景、范围与里程碑 |
| architecture/ | 系统架构、AIGC/MCP/pybridge、混合后端、字幕等 |
| api/ | 接口说明与 OpenAPI 3 规范 |
| database/ | 库表约定、迁移流程、ER 图 |
| business/ | 领域模型与关键流程 |
| conventions/ | 后端/前端 API 规范、运行约定 trae |
| web/ | Web 前端技术架构与开发配置 |
| operations/ | 环境、发布、监控与故障排查 |
| adr/ | 架构决策记录（ADR）模板与约定 |
| agent/ | 选题智能体、账号规划等设计 |
| storyboard/ | 分镜：开发指南、产品流程、布局与提示优化 |
| pybridge/ | 智能包装等 pybridge 专项文档 |
| social-publisher/ | 社交媒体自动发布工具 |
| tool/ | 工具专项（Midjourney 案例视频生成器等） |
| guides/ | 功能指南（AIGC/质量/FFmpeg/抖音/AutoDL 等） |
五、常用入口
运行约定：
conventions/trae.md后端 API 本地：
http://localhost:8000/（以实际配置为准）Web 前端开发：
http://localhost:5173/（以实际配置为准）功能指南（AIGC/质量/FFmpeg/抖音/AutoDL 等）：guides/README.md、00-INDEX.md 的「功能与指南」。
更多按角色与任务的索引见 00-INDEX.md。
六、文档维护与优化
- 进一步优化方向（补齐、导航、一致性、自动化等）：DOCS-OPTIMIZATION.md。