文档快速索引
按「角色/任务」和「功能」快速找到要看的文档。
我是新人,先看什么
- 项目全貌:docs/README.md — 子项目说明与文档结构。
- 本地怎么跑:
- 后端 API:见 api/README.md 或仓库根
api/的 README。 - Web 前端: web/README.md、web/DEVELOPMENT_CONFIG.md。
- 后端 API:见 api/README.md 或仓库根
按角色/任务
后端(ThinkPHP / api)
| 需求 | 文档 |
|---|---|
| 接口规范与响应格式 | conventions/backend-api-standards.md |
| 接口列表与 OpenAPI | api/README.md、api/openapi.yaml |
| 数据库命名与迁移 | database/README.md |
| ER 图 | database/MERMAID-ER.md |
前端(Vue / web)
| 需求 | 文档 |
|---|---|
| 项目架构与功能模块 | web/README.md |
| 开发环境与配置 | web/DEVELOPMENT_CONFIG.md |
| 前端调用 API 规范 | conventions/frontend-api-integration.md |
| 分镜生成 message_filter 兼容 | web/message_filter.md |
| 权限与 H5 分享等 | web/permissions-fix.md、web/douyin.h5.share.md |
AIGC / 分镜 / 智能体
| 需求 | 文档 |
|---|---|
| 分镜闭环与 MCP、pybridge | architecture/aigc-agents-mcp-pybridge.md |
| 智能体开发路线图 | architecture/agent-development-roadmap.md |
| 选题智能体设计 | agent/topic-agent-design.md |
| 账号规划智能体 | agent/account-planning-agent.md |
| 分镜布局与选题优化 | storyboard/admin-分镜布局优化.md、[storyboard/分镜选题优化 qoder20260101.md](storyboard/分镜选题优化 qoder20260101.md) |
| 生成分镜提示优化 | [storyboard/生成分镜提示优化 gemini.md](storyboard/生成分镜提示优化 gemini.md) |
| StoryBoard.vue 业务逻辑与流程图 | storyboard/storyboard-business-flow.md |
| 酒店智能体(新建)⭐ | product/hotel-agent-strategy.md、product/hotel-web-project-plan.md |
运维与发布
| 需求 | 文档 |
|---|---|
| 运维总览 | operations/README.md |
| 后台会话策略 | operations/admin-session.md |
| AutoDL 自动化 | operations/autodl-automation.md |
| 运行与脚本约定 | conventions/trae.md |
架构与决策
| 需求 | 文档 |
|---|---|
| 架构目录总览 | architecture/README.md |
| Git Worktree 多项目分支策略 | architecture/git-worktree-multi-repo-strategy.md |
| 字幕(火山引擎) | architecture/subtitles-volcengine.md |
| 写 ADR | adr/README.md |
功能与指南(按功能名查)
| 功能/主题 | 文档 |
|---|---|
| AIGC 生成视频业务优化 | guides/aigc生成视频业务优化.md |
| 一键优化(自动增强) | guides/auto-enhance-guide.md |
| 视频质量打分 | guides/quality-score-guide.md |
| FFmpeg 运镜/转场/字幕 | guides/ffmpeg-camera-transition-guide.md |
| 视频合成预设(高质量导出) | guides/video-preset-feature.md |
| 抖音自动发布 | guides/douyin-auto-publish-guide.md |
| AutoDL 需求与规划 | guides/autodl-相关需求与规划整理.md |
| Midjourney 案例视频生成器 | tool/midjourney/README.md(修复清单、v2 设计、升级总结) |
| pybridge 智能包装 | pybridge/smart-packaging.md |
| pybridge 视觉风格与 Hooks | pybridge/visual-styles-and-hooks.md |
| Social Publisher 自动化发布 | social-publisher/README.md |
| 修复与约定 | conventions/fix.md |
业务与产品
| 主题 | 文档 |
|---|---|
| 分镜产品与流程 | storyboard/product-and-flow.md |
| 业务与领域说明 | business/README.md |
| 观音智眼品牌视觉与文案体系 | product/guanyin-smart-eye-brand-vi.md |
使用建议:先定角色(后端/前端/AIGC/运维)或功能名,再从上表对到具体文档。