专栏首页子勰随笔怎样的版本历史才是一个好的版本历史

怎样的版本历史才是一个好的版本历史

做SDK一直以来,除了之前提过的文档的问题,另一个比较多的抱怨就是关于版本更新。由于

  • 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链接)
	- ……

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • SDK热更系列之SDKHotfix待优化点

    子勰
  • SDK开发经验之版本

    子勰
  • 关于终端设备的设备唯一性的那些事之MAC地址

    子勰
  • 用AutoLayout实现分页滚动

    UIScrollView的pagingEnabled属性用于控制是否按分页进行滚动。在一些应用中会应用到这一个特性,最典型的就是手机桌面的应用图标列表。这些界面...

    欧阳大哥2013
  • 一分钟实现Android遮罩引导视图

    GuideView是一种基于DialogFragment实现的引导遮罩浮层视图的轻量级解决方案,它具备以下的特性:

    砸漏
  • 探索SQL Server元数据(一)

      在数据库中,我们除了存储数据外,还存储了大量的元数据。它们主要的作用就是描述数据库怎么建立、配置、以及各种对象的属性等。本篇简单介绍如何使用和查询元数据,如...

    用户1217611
  • Python的堆操作,是不是要掌握一下

    Python的强大并不在于它的语法,而在于它的库,当你对各种数据结构感到苦恼时,Python提供了各种开箱即用的数据结构。

    疯狂软件李刚
  • Laravel 视图使用入门

    我们在之前几篇教程中定义的路由大多数返回的都是纯字符串文本或者字符串拼接的 HTML,这主要是为了测试方便,在实际开发中,除了 API 路由返回指定格式数据对象...

    学院君
  • 【译文】Spark高速实时分析

    Apache Hadoop是一个成熟的开发框架,它有庞大的生态系统,并得到了Cloudera,Hortonworks,雅虎等重要参与者的支持和贡献。Apache...

    小莹莹
  • 基于类的通用视图:ListView 和 DetailView

    在开发网站的过程中,有一些视图函数虽然处理的对象不同,但是其大致的代码逻辑是一样的。比如一个博客和一个论坛,通常其首页都是展示一系列的文章列表或者帖子列表。对处...

    追梦人物

扫码关注云+社区

领取腾讯云代金券