指南总览

这组指南按"决策路径"组织，而不是只按包名罗列。

如果你刚接触生成器开发者平台，不建议一开始就逐篇阅读 API 文档，而应该先回答三个问题：

1. 你要做的是什么类型的生成器？
2. 你需要自定义应用壳，还是官方统一应用壳？
3. 你是手动开发，还是通过 AI 协助开发？

一张表理解平台分层

层	负责什么	什么时候读
generator-sdk	登录、计费、导出、云保存、历史记录、模板辅助等平台能力	你要在生成器里接平台 API
generator-workbench（应用壳）	官方壳层 UI 与标准宿主布局	你想直接复用平台壳层，而不是自己重做
生成器需要发布模板能力	生成器需要发布模板,需要应用壳和生成器之间的运行时协议	你需要 schema 驱动参数面板，或应用壳挂载控制
generator-sdk-mcp + skills	AI 读取真实文档与遵循平台工作流的工具层	你希望 AI 帮你生成或改造生成器

推荐阅读顺序

如果你已有生成器，想快速接入应用壳

1. 核心概念 ← 先建立心智模型（5 分钟）
2. 手把手接入教程（Basic 档位） ← 再跟着操作
3. 功能与配置参考 ← 遇到具体功能时查阅

如果你从零开始开发 Vue 生成器

1. Vue 脚手架启动开发 ← 一条命令生成并启动 Vue 3 + Vite + 应用壳项目
2. Vue 脚手架结构说明 ← 需要了解目录、配置和扩展方式时再读
3. 核心概念 ← 理解应用壳、runtime、能力档位的职责边界
4. 应用壳与生成器通信 ← 开始扩展事件、状态和导出链路时查阅

如果你在评估整个平台

1. 接入决策树
2. 开发者旅程
3. 整体架构

如果你准备通过 AI 开发

1. AI / Vibe Coding 工作流
2. 生成器开发者上手
3. 核心概念
4. 功能与配置参考
5. 应用壳与生成器通信
6. 主站 Embed 宿主接入
7. 生成器接入协议

如果你准备手动接入 SDK

1. 安装与引入
2. SDK 总览
3. SDK 初始化
4. 鉴权设计

每篇文档分别解决什么问题

• 看 接入决策树：决定是 SDK only、SDK + 应用壳、自定义壳层，还是 AI 路线。
• 看 核心概念：理解三层角色、宿主壳模式、路由模式、能力档位和职责边界，建立正确心智模型。
• 看 Vue 脚手架启动开发：从零创建并启动 Vue 3 + Vite + generator-workbench 标准生成器项目。
• 看 Vue 脚手架结构说明：了解脚手架目录、配置项、Runtime Contract、样式策略和能力升级方式。
• 看 手把手接入教程：已有生成器，只接登录 / 积分 / 计费 / 导出，一步步跟着操作。
• 看 功能与配置参考：了解应用壳每个功能的工作原理和完整配置选项。
• 看 开发者旅程：理解从本地原型到具备发布条件的完整交付路径。
• 看 整体架构：理解本地生成器、SDK、应用壳和平台侧发布链路之间的关系。
• 看 应用壳与生成器通信：集中理解应用壳与生成器的双向通信、routeMode、select_template 和反向命令。
• 看 主站 Embed 宿主接入：当主站要改 iframe 通信时序、bridge 握手和模板初始化方式时，直接按这篇改。
• 看 应用壳升级：当已有 CDN 接入生成器要跟进新的壳层能力时，查看升级分类、manifest 和检查清单。
• 看 生成器接入协议：了解应用壳与生成器之间的协议细节。
• 看 SDK 总览：在进入 API 参考前，先建立模块级心智模型。

这组指南刻意不做的事

这组指南不重复 API 参考的细节。

当你已经知道要接哪个模块时，直接跳到：

• API 参考
• 接入示例
• MCP 文档