diff --git a/README.md b/README.md index 2062a6e..f7e646d 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,84 @@ -# 灵犀 · 信息流素材一站式生产平台 +# 灵犀 · 信息流广告素材一站式生产平台 -面向信息流广告投放（电商、金融等多行业）的素材生产线：把「脚本生成 → 素材生产 → 编辑审核 → 管理沉淀」收成一条流程清晰、过程可控的主线，用模板承接重复劳动，用统一编辑入口守住质量，把每次产出沉淀为可复用的组织资产。 +面向信息流广告投放的素材生产平台：**行业包 → 要素卡 → 脚本 → 素材 → 快筛 → 导出即归档**。 + +- **图片线**：确定性批量流水线（PSD 模板套版 + 自动抠图 + 多规格合成），不做 AI 生图。 +- **视频线**：AI 逐镜图生视频（关键帧 → 单镜 → 拼接 → 校验）。 +- **内核不分行业**：电商、金融等差异收敛为可配置**行业包**，新行业只换配置、不发版。 + +--- ## 文档索引 -| 文档 | 版本 | 说明 | -| --- | --- | --- | -| [PRD · 信息流素材生产平台](docs/PRD/灵犀_信息流素材生产平台_PRD_V0.3.md) | **V0.3（最新）** | 行业含义改为业务属性（电商 / 金融等）；录入拆为行业模块、客户模块（自定义填写）；管理模块新增信息模块（行业 → 客户上下级菜单）；新增视频方向；视频制作支持方向选取、生成数量、在线预览、通用字符命名与下载；含图片 / 脚本 / 视频三张流程图 | -| [PRD · 信息流素材生产平台](docs/PRD/灵犀_信息流素材生产平台_PRD_V0.2.md) | V0.2 | 创作→编辑模块，新增录入；图片制作增加生成数量与预览勾选；图片模板、产品位置升 P0；管理模块支持行业 / 客户划分与预览 | -| [PRD · 信息流素材生产平台](docs/PRD/灵犀_信息流素材生产平台_PRD_V0.1.md) | V0.1 | 初稿：背景与目标、四大模块（脚本生成 / 素材生产 / 创作 / 管理）功能骨架 | +| 文档 | 路径 | 版本 | 作用 | +| --- | --- | --- | --- | +| **项目总纲** | [AGENTS.md](AGENTS.md) | V1.0 | 硬约束、技术栈、仓库结构、命令契约、流程 | +| **PRD** | [灵犀-信息流广告素材一站式生产平台PRD.md](docs/PRD/灵犀-信息流广告素材一站式生产平台PRD.md) | **V1.6（最新）** | 需求、业务规则（R-01~R-30）、验收标准 | +| **技术架构** | [灵犀_信息流素材生产平台_技术架构_V0.1.md](docs/技术架构/灵犀_信息流素材生产平台_技术架构_V0.1.md) | **V0.4（内部版本）** | 技术选型、分层模块、数据模型、接口、ADR | +| 立项建议 | [灵犀_信息流素材生产平台_立项建议书_V0.1.md](docs/立项建议/灵犀_信息流素材生产平台_立项建议书_V0.1.md) | V0.1 | 背景、目标、投入产出论证（不约束实现） | +| **工程规范** | [docs/工程规范/](docs/工程规范/README.md) | V1.0 | Git、代码风格、格式化、API、数据库、测试、Review、日志、密钥、资产命名 | +| 历史 PRD | `docs/PRD/灵犀_信息流素材生产平台_PRD_V0.1~V0.3.md` | 归档 | 仅作沿革参考，**不具约束力** | -## 四大模块 +> 阅读顺序：`AGENTS.md` → PRD §1/§6 → 技术架构 §0.2/§3 → 按任务查 `docs/工程规范/`。 -| 模块 | 定位 | 产出 | +--- + +## 核心链路（五步） + +| 步骤 | 动作 | 产出 | | --- | --- | --- | -| 脚本生成 | 按行业、客户、脚本模板、产品信息、数量批量产出脚本，自动命名 | 待审核脚本（输出至编辑模块） | -| 素材生产 | 图片制作（生成 → 预览勾选 → 导出）与视频制作（方向 → 生成 → 预览 → 命名下载） | 图片 / 视频成片 | -| 编辑 | 统一编辑与资产生产入口：行业模块、客户模块、脚本方向、视频方向、脚本审核、Logo、图片模板、产品位置、警示语 | 行业 / 客户信息 + 入库资产 | -| 管理 | 信息模块（行业 → 客户上下级菜单）与六类资产（脚本、视频方向、图片模板、产品位置、Logo、警示语）的统一维护 | 可复用资产库 | +| 1 | 建行业 / 客户信息，选行业包并套客户资产包 | 归属根节点就绪 | +| 2 | 要素卡 + 卖点库 → 脚本生成 / 校核 / 审核入库 | 已入库脚本（带编号） | +| 3 | 图片批次（模板 × 商品图 × 规格）/ 视频逐镜生成 | 候选素材 | +| 4 | 按组并排快筛，勾选保留项 | 待导出素材 | +| 5 | 导出（固定目录 + 命名规则）+ 自动归档 | 可投素材 + 交付清单 | + +--- + +## 功能模块（PRD V1.6） + +| 模块 | 定位 | +| --- | --- | +| **脚本** | 要素卡 / 卖点库 / 模板 / 生成 / 质量校核 / 审核入库 / 版本 | +| **素材** | 图片线（PSD 套版、抠图、规格矩阵）、视频线（逐镜生成、变体）、快筛与预览 | +| **资产** | 15 类资产的库、版本、引用、复审与复用度量 | +| **平台管理** | 组织账号、客户、角色权限、AI 配置、数据字典、审计、行业包与表单设计器 | + +> 早期文档中的「四大模块（脚本生成 / 素材生产 / 编辑 / 管理）」已于 PRD V1.6 重构为「脚本 / 素材 / 资产 / 平台管理」三主线 + 一底座。 + +--- + +## 目录结构（目标态） + +``` +apps/api NestJS HTTP + SSE + AI 回调 +apps/worker 异步任务（图片 / 视频 / 导出 / 入库） +apps/web React SPA +packages/ shared · form-engine · render · ai-sdk · ui +prisma/ 数据模型与迁移 +infra/ compose、Nginx、监控、备份 +docs/ PRD / 技术架构 / 立项建议 / 工程规范 +``` + +当前仓库处于**规范与设计阶段**，尚未建代码；建仓必须遵循 [AGENTS.md §5](AGENTS.md) 的结构与依赖方向。 + +--- + +## 本地开发（建仓后适用） + +```bash +cp .env.example .env.local +pnpm compose:up # PostgreSQL 18 / Redis 7.4 / MinIO +pnpm db:migrate +pnpm dev +``` + +命令与门禁见 [AGENTS.md §6](AGENTS.md) 与 [06-测试与CI规范](docs/工程规范/06-测试与CI规范.md)。 + +--- + +## 约定速查 + +- 包管理只用 **pnpm**，Node 锁定 **24.15.0**；UI 只用 **Semi Design**，图标只用 **Remix Icon**。 +- 客户数据隔离、审计 append-only、导出全留痕、阈值单一来源、低质量不可静默——均为硬约束。 +- 完整红线见 [AGENTS.md §3](AGENTS.md)。