Shiply SDK 集成文档地图
本文件是 shiply-sdk-integration skill 的远程文档索引。AI 助手通过 WebFetch 获取本文件后,按相对路径拼接完整 URL 访问具体文档。
AI 助手使用方式
- WebFetch 本文件:
https://shiply.tds.qq.com/document/getting-started-guide/integration-docs-map/ - 根据用户问题,从索引中匹配相关文档的相对路径
- 拼接完整 URL 获取最新内容:
https://shiply.tds.qq.com/document/<相对路径>
路由决策树
子系统识别
| 用户提问关键词 | 子系统 | 文档区域 |
|---|---|---|
| 专业版、ShiplyPro、Pro、统一接入、一次性集成、全部能力 | ShiplyPro 专业版 | ShiplyPro 专业版集成(推荐) |
| 配置、开关、远程配置、RDelivery | 配置 RDelivery | 一、远程配置 SDK 集成 |
| TAB、TAB实验、实验 | 配置类 | 一、远程配置 SDK 集成 |
| 资源、资源下载、ResHub、差分 | 资源 ResHub | 二、远程资源 SDK 集成 |
| 升级、灰度升级、应用内升级 | 应用内升级 | 三、应用内升级 SDK 集成 |
| 热修复、hotfix | 热修复 | 四、热修复 SDK 集成 |
| 动态化、Flutter动态化、Kuikly、React Native热重载、RN热重载 | 跨平台动态化 | 五、跨平台动态化 SDK 集成 |
| 通用概念、概念、术语、envId、systemId、更新策略 | 通用概念 | platform-user-guide/concepts |
| 拉不到、不生效、看不到日志、排查 | 排障 | 通用概念 & 排障 |
平台识别
| 用户提问关键词 | 平台 |
|---|---|
| iOS、iPhone、iPad | iOS |
| Android、安卓 | Android |
| 鸿蒙、Harmony、ArkTS | Harmony |
| Flutter、Dart | Flutter |
| Windows、C++、Win32 | Windows |
| Kuikly | Kuikly |
| React Native、RN | React Native |
接入方式识别
| 用户提问关键词 | 接入方式 | 说明 |
|---|---|---|
| 专业版、ShiplyPro、Pro、统一接入、一次性集成、全部能力 | ShiplyPro 专业版 | 统一初始化入口,一次性集成配置/资源/应用内升级/所有能力(不含热修复),推荐优先使用 |
| 单独接入、只集成配置、只集成资源 | 按需接入 | 仅集成所需子系统 |
ShiplyPro 专业版集成(推荐)
ShiplyPro SDK 提供了统一初始化入口,可一次性集成远程配置、远程资源、应用内升级全部能力(不含热修复)。推荐优先接入专业版,避免后续重复集成。
| 平台 | 文档链接 | 说明 |
|---|---|---|
| iOS | integration-ios-sdk | iOS 端 ShiplyPro SDK 初始化与依赖引入 |
| Android | integration-android-sdk | Android 端 ShiplyPro SDK 初始化与依赖引入 |
| Harmony | integration-harmony-sdk | 鸿蒙端 ShiplyPro SDK 初始化与依赖引入 |
提示:如果用户已接入专业版,后续只需在 Shiply 平台上开启对应的子系统和能力即可,无需重复集成 SDK。
一、远程配置 SDK 集成(RDelivery)
远程配置开关、AB 实验、参数动态下发。单独接入配置能力时选择此路径。
| 平台 | 文档链接 | 说明 |
|---|---|---|
| iOS | ios-sdk-integration | iOS 端 RDelivery 配置 SDK 接入 |
| Android | android-sdk-integration | Android 端 RDelivery 配置 SDK 接入 |
| Harmony | harmony-sdk-integration | 鸿蒙端 RDelivery 配置 SDK 接入 |
配置 SDK 高级功能
| 主题 | 文档链接 | 说明 |
|---|---|---|
| 配置快速入门 | quick-start | 创建配置、发布、客户端读取的完整流程 |
| 配置概览 | overview | 远程配置功能定位与核心概念 |
| 配置 FAQ | faq | 配置相关常见问题与解答 |
| 配置模板 | config-templates | 使用模板批量管理配置项 |
| 配置更新日志 (Android) | android-update-log | Android 配置 SDK 版本变更记录 |
| 配置更新日志 (iOS) | ios-update-log | iOS 配置 SDK 版本变更记录 |
| 配置更新日志 (Harmony) | harmony-update-log | Harmony 配置 SDK 版本变更记录 |
二、远程资源 SDK 集成(ResHub)
资源文件(图片、配置包、模型等)远程下载与差量更新。单独接入资源下载能力时选择此路径。
| 平台 | 文档链接 | 说明 |
|---|---|---|
| iOS | ios-sdk-integration | iOS 端 ResHub 资源 SDK 接入 |
| Android | android-sdk-integration | Android 端 ResHub 资源 SDK 接入 |
| Flutter | flutter-sdk-integration | Flutter 端 ResHub 资源 SDK 接入 |
| Harmony | harmony-sdk-integration | 鸿蒙端 ResHub 资源 SDK 接入 |
| Windows | windows-sdk-integration | Windows 端 ResHub 资源 SDK 接入 |
资源 SDK 高级功能
| 主题 | 文档链接 | 说明 |
|---|---|---|
| 资源快速入门 | quick-start | 上传资源、发布、客户端拉取的完整流程 |
| 资源概览 | overview | 远程资源功能定位与核心概念 |
| 资源 FAQ | faq | 资源相关常见问题与解答 |
| 拉项目资源 | pull-project-resource | 项目级资源拉取使用指南 |
| 资源更新日志 (Android) | android-update-log | Android 资源 SDK 版本变更记录 |
| 资源更新日志 (iOS) | ios-update-log | iOS 资源 SDK 版本变更记录 |
| 资源更新日志 (Harmony) | harmony-update-log | Harmony 资源 SDK 版本变更记录 |
三、应用内升级 SDK 集成
App 版本灰度升级、强制更新弹窗。仅 Android 平台支持。
| 平台 | 文档链接 | 说明 |
|---|---|---|
| Android | android-sdk-integration | Android 端应用内升级 SDK 接入 |
升级 SDK 相关文档
| 主题 | 文档链接 | 说明 |
|---|---|---|
| 升级快速入门 | quick-start | 创建升级任务、灰度发布、客户端触发的完整流程 |
| 升级概览 | overview | 应用内升级功能定位与核心概念 |
| 升级 FAQ | faq | 升级相关常见问题与解答 |
四、热修复 SDK 集成
Android 端线上 Bug 热修复,无需发版即可修复线上问题。仅 Android 平台支持,需单独集成。
| 平台 | 文档链接 | 说明 |
|---|---|---|
| Android | android-sdk-integration | Android 端热修复 SDK 接入 |
热修复 SDK 相关文档
| 主题 | 文档链接 | 说明 |
|---|---|---|
| 热修复快速入门 | quick-start | 发布补丁、客户端加载修复的完整流程 |
| 热修复概览 | overview | 热修复功能定位与核心概念 |
| 热修复 FAQ | faq | 热修复相关常见问题与解答 |
五、跨平台动态化 SDK 集成
Flutter 动态化、Kuikly 动态化、React Native 热重载等跨平台框架的动态下发能力。适用于需要动态更新 UI 或业务逻辑的场景。
| 平台/框架 | 文档链接 | 说明 |
|---|---|---|
| Flutter 动态化 | flutter-sdk-integration | Flutter 端动态化 SDK 接入,支持动态下发 Flutter 页面 |
| Kuikly 动态化 | kuikly-sdk-integration | Kuikly 框架动态化 SDK 接入 |
| React Native 热重载 | rn-sdk-integration | React Native 端热重载 SDK 接入,支持 JS Bundle 动态下发 |
动态化 SDK 高级功能
| 主题 | 文档链接 | 说明 |
|---|---|---|
| Flutter 动态化快速入门 | quick-start | Flutter 动态化功能接入与使用快速入门 |
| Flutter 动态化概览 | overview | Flutter 动态化功能定位与核心概念 |
| Flutter 动态化 FAQ | faq | Flutter 动态化常见问题与解答 |
| Flutter 模块集成 | module-integration-doc | Flutter 模块集成到原生工程的详细指南 |
| Kuikly 动态化快速入门 | quick-start | Kuikly 动态化功能接入与使用快速入门 |
| Kuikly 动态化概览 | overview | Kuikly 动态化功能定位与核心概念 |
| React Native 热重载快速入门 | quick-start | React Native 热重载功能接入与使用快速入门 |
| React Native 热重载概览 | overview | React Native 热重载功能定位与核心概念 |
六、平台通用文档(参考)
推荐首读:⭐ 标记的「平台概览」是了解 Shiply 整体能力的最佳入口。以下文档为跨平台共享的参考内容。
| 主题 | 文档链接 | 说明 |
|---|---|---|
| ⭐ 平台概览 | platform-overview | Shiply 平台整体介绍、功能矩阵与适用场景(推荐首读) |
| 入门指南 | integration-process | 平台整体接入流程与前置准备 |
| 平台用户指南 | concepts | 平台核心概念:凭证、环境、更新策略等 |
| 通用 FAQ | faq | 平台通用常见问题与解答 |
| 条款与政策 | terms-and-policies | 服务条款与隐私政策 |
通用概念 & 排障(跨平台共享)
接入过程中遇到概念不理解或功能不生效时,先查阅此区域。
| 主题 | 文档链接 | 说明 |
|---|---|---|
| 通用概念与术语 | concepts | 凭证、环境、更新策略、systemId、依赖注入等核心概念解释 |
| 通用排障指南 | concepts | 平台通用概念中涵盖常见问题排查指引 |
| 配置拉取排障指南 | task-pull-troubleshooting-guide | 配置拉不到、不生效的专项排查流程 |