Merge pull request #203 from wechat-miniprogram/feature/update-doc

Feature/update doc

Design/DataCDN.md

@@ -59,6 +59,16 @@ AssetBundle和Addressables资源目录。
 3. 单个请求文件最大**不超过100MB，超时默认为60s**(理论最大值，实际游戏永远不要让单个文件这么大，考虑到玩家平均下载带宽，建议单文件2~5MB以内)
 4. 网络安全域名、跨域、SSL等问题请参考文档[网络通信适配](UsingNetworking.md)
 
+## 资源更新说明
+> 请注意!!! bundle的配置文件，比如aa的`setting.json`和`catalog.json`，以及`AssetBundles`打包生成的配置文件通常没有带上hash，为了避免新版本发布时由于cdn缓存导致加载到旧版本资源，需要避免这些文件使用缓存。通常有以下两种方式避免。
+
+1. 每次发新版本更换cdn路径，比如`version1/xxxx`,`version2/xxxx`
+2. 不希望被缓存的文件，源站或者cdn加上不允许缓存的HTTP头，如`no-cache`，请自行查询对应cdn服务商文档进行设置
+
+同时，由于通过HTTP请求的资源会自动缓存，不希望被缓存的文件请添加到缓存忽略目录，具体可阅读后续**资源缓存规则**文档
+
+> 除非了解小程序更新机制，请勿删除旧版本资源，否则可能导致旧版本游戏的用户运行报错，具体请移步[版本更新](Update.md)
+
 ## 资源缓存
 这里主要讲UnityLoader的资源缓存策略。
 

Design/Update.md

+# 版本更新
+
+## 代码更新
+请阅读文档，了解小游戏的[更新机制](https://developers.weixin.qq.com/minigame/dev/guide/runtime/update-mechanism.html)
+
+## 更新策略：
+### 1. 静默更新（默认方式）
+这种形式和APP版本类似，比如应用市场自动更新。游戏发新版本后，**在打开小游戏前，会静默更新到最新版本**。
+但小游戏包体的更新机制和APP不同，开发者在管理后台发布新版本的小游戏之后，**无法立刻影响到所有现网用户**，如果某个用户本地有小程序的历史版本，此时打开的可能还是旧版本，**最差情况下，也在发布之后 24 小时之内下发新版本信息到用户**。
+
+> 缺点：更新不及时，依然可能体验到旧版本内容，需要注意保证旧版本资源可访问。
+
+适合于对版本一致性要求不高的游戏使用
+
+### 2. 强制更新
+#### 2.1 实时检测更新(UpdateManager)
+戏运行期间检查是否有新版本，**当新版本可用后，提示用户重启更新**
+
+<img src="../image/update-dialog.png" width="320">
+
+转换插件有提供配置来自动使用这项能力，通过勾选`MiniGameConfig.asset`中的`needCheckUpdate`。
+
+> 缺点：由于重启后，可能涉及资源下载，可能导致用户流失。
+
+#### 2.2 设置最低可用版本 
+- 如果希望用户始终打开最新版本，可通过`mp后台-设置-基本设置-小程序最低可用版本`，修改为最新版本
+
+## 资源更新
+请查看[资源部署-资源更新说明](./DataCDN.md)
\ No newline at end of file

README.md

@@ -46,8 +46,6 @@
   - [使用 Addressable 进行资源按需加载](Design/UsingAddressable.md)
   - [使用 AssetBundle 进行资源按需加载](Design/UsingAssetBundle.md)
   - [使用 Unity Instant Game 进行资源按需加载](Design/InstantGameGuide.md)
-  - [资源服务器部署注意事项](Design/DataCDN.md)
-  - [资源缓存](Design/FileCache.md)
   - [定制启动封面](Design/CustomLoading.md)
   - [使用预下载功能](Design/UsingPreload.md)
   - [首场景启动优化](Design/FirstSceneOptimization.md)
@@ -65,6 +63,11 @@
   - [资源优化工具与建议](Design/AssetOptimization.md)
   - [iOS高性能模式](Design/iOSOptimization.md)
 
+版本更新与资源部署
+- [版本更新](Design/Update.md)
+- [资源服务器部署注意事项](Design/DataCDN.md)
+- [资源缓存](Design/FileCache.md)
+
 能力适配
 
 - [WX SDK 平台能力适配](Design/WX_SDK.md)