我的开源项目更新文档进化史

[moonrailgun]

最早时代

没有更新文档，没错，完全是随缘发版。你可以通过 git commit 来猜到迭代了什么功能（因为 git commit message 还是好好写的）

但是具体怎么去理解就要看缘分了

自动化时代

在这个阶段，已经能够通过第三方命令行工具在发版的时候自动收集 git commit message 来产出 CHANGELOG.md 文件了。比之前好的在于用户可以一目了然的看到两次版本之间发生了那些比较重要的变更，至少有一个最低限度可用的版本进化史了。

在 github 的 release 页面也有东西可填了。此时他可能是长成这样的

当然缺点还是比较抽象，对于普通用户来说可能还是比较抽象，难以理解

人话翻译版

在这个阶段，是属于将改动从程序员可以理解(也许也不能理解？)的版本翻译成一般用户也能理解的版本。

这个版本就适合放在官网上或者其他地方了。缺点是需要花费一些精力与时间。如果你面向的用户是多个国家的则需要多国语言版本

图文并茂版

在这个阶段就开始精心雕琢项目的更新文档了，插入图片能够更好的帮助大家理解更新的内容，缺点是因为图文混排所以就很难在微信这类不支持图文混排的工具中传播更新内容了。

当然道高一尺魔高一丈，我们可以直接截长图的方式直接贴个图片。

这个阶段的更新文档大概是这样的:

精修内容

在这个阶段会通过增加动图的方式来进一步告知用户更新的内容，帮助用户理解更新的内容。

以下是一个动图示例:

相比于静态的图片，动图无异能够更好帮助用户去理解改动的不同。

总结

以上是我自己开源项目 Tailchat: 一个开源的社区化即时通讯应用软件 的更新文档进化史，你可以在我的官网博客中看到完整的改变历程(包括中英双语)。所以同样是开源开发者，你们进行到哪一步了呢？

或者说下一个阶段你觉得能够如何降低用户的理解成本呢？

[wkong]

厉害👍

[initObject]

学习