做SDK一直以来,除了之前提过的文档的问题,另一个比较多的抱怨就是关于版本更新。由于
当游戏接入新功能的时候,很容易遇到的问题就是需要替换版本时,他们从老版本升级到当前版本要做什么,他们无法知道对应的功能更新在什么地方可以看到,或者他们需要做什么工作。
为了解决这个问题,SDK的版本做了几次更新,最后形成了一个还在试验中,但是感觉已经相对会明晰很多的版本历史记录方法,作为参考。
最早期的版本文档,只是简单记录了版本变更的概要,例如:
XX版本变更内容
1. 增加了XX功能
2. 修复了XX引起的一个bug
3. ……
里面只是简单列出变更的内容,开发商无法了解到变更的内容,以及更新需要做的工作,尤其是由于SDK内容较多,导致文档内容很多。开发商每次都要彻底过一遍文档,然而大部分内容没有变更,导致开发商极易遗漏一些小的变更点。初期曾尝试在文档中做变更标记,后来发现随着版本增多,文档可读性越来越低。最后还是采用版本历史来描述版本变更内容,在版本历史中同时增加SDK和文档变更的内容。
##更新以后的版本说明
这次调整以后,版本更新概要变成如下的样子:
XX版本变更内容
代码变更:
1.XX功能变动
【修改】 调整XXX接口
2.修复XXbug
【删除】 删除XX代码的某处理逻辑,解决XXX引起的问题
3.……
文档调整:
【删除】 删除第X章XX部分对于某功能的说明
【修改】 增加对XX接口调用事例的说明
这次调整以后明显有了改观,但是游戏还是有意见,他们认为没有虽然很清晰,但是其实里面有一些内容他们并不需要关注,但是罗列在一起还是相对繁杂。另外上面的模式,不方便使用markdown编辑,根据意见最终修改为下面的格式:
目前SDK使用的就是下面的版本更新说明,当然这也并不最好的模式,版本更新文档变的越来越大。我们也在尝试更好的方式。
### XX版本变更内容
#### 代码变更:
- 新增功能:
1. XX功能
XX功能主要提供……
- 增加API XXX
通过XXAPI,可以轻松实现…………
- 功能调整:
1. XX API调整
将XX API的参数从int转为枚举……
- BUG修复
1. 修复XX逻辑引起的XX问题
#### 文档调整:
- 增加:
1. XX模块增加关于XX功能的描述(Wiki链接)
- 修改:
1. 修改XX模块中关于XX功能的权限声明(Wiki链接)
- ……