版本更新

当 SDK 不断的更新的迭代的时候,当然 API 文档也少不了更新,如何维护更新是个问题。

兼容性

API 文档最好有对其接口的兼容性说明,还有系统开发环境变更的更新说明,及如何升级回退的说明,方便开发者查阅。

Changelog

除了 API 文档的更新说明,还需要内部开发的一套 Git Commit Message 规范,能很好的生成 Changelog,方便定位解决问题和更新日志的自动化生成。

results matching ""

    No results matching ""