Kjerr值得照着写的
更新日志示例。
好的更新日志示例有三个共同点：标题直接说出变了什么，有一句话讲用户现在能做什么，并且如实交代接下来该做什么。下面是四个条目，每种变化一个，之后是更新日志与发布说明的区别，以及一份检查清单。
四个更新日志示例，按分类
下面每个示例都是为一款虚构的产品写的，对应 Kjerr 的公告栏目所用的四个分类。请借用结构，不要照搬字句。
新功能
两步验证来了
现在，您可以在登录时多加一步来保护账号。打开“设置”，进入“安全”，用任意一款身份验证器应用扫描二维码，并保存好恢复码。工作区所有者可以要求每位成员都开启。这是我们看板上呼声最高的需求之一。
好在哪里： 开头就说用户现在能做什么，告诉他们去哪里找，并且点明这是用户自己提的需求。
改进
报表加载速度最多提升到三倍
我们重写了报表的计算方式。大账号的月度汇总以前要六秒才能打开，现在不到两秒；超过一年的日期范围也不再超时。数字本身没有任何变化。
好在哪里： 给出一个读者感受得到的数字，并打消“数据是不是变了”的疑虑。
修复
已修复：CSV 导出会漏掉最后一行
超过 10,000 行的导出文件此前会缺少最后一行。问题已经修复，从今天起的导出都是完整的。如果您在 8 月上半月导出过大型报表，请重新导出一次。
好在哪里： 说清楚哪里出了错、影响了谁、他们该怎么做。不绕弯子。
公告
这个秋天我们在做什么
根据各位的投票，简单说说接下来几个月的安排。Slack 通知正在开发中。接下来是深色模式：它是看板上票数最高的想法，设计已经开始。每一项上线时，我们都会在这里发文。
好在哪里： 给出预期，却不许下守不住的日期，并且把话头引回投票。
一条管用的更新日志由什么组成
- 标题：写变化，不写版本号。 “报表加载速度最多提升到三倍”能让读者判断这事和自己有没有关系。“v4.12.1”不能。
- 分类。 新功能、改进、修复或公告。方便读者快速浏览和筛选。
- 现在能做什么。 一两句话，站在用户这一侧来写。
- 去哪里找。 菜单路径，或者一个链接。
- 接下来该做什么。 多数时候什么都不用做。如果修复之后需要重新导出，或者改一项设置，就直接说。
- 注明需求来源。 如果这是用户提过的，就链接到那条需求。要证明反馈有人在看，这是成本最低的办法。
更新日志与发布说明的区别
更新日志是对每一项值得一提的变化的持续记录；发布说明（release notes）是对某一次发布的完整说明。更新日志是一份用来扫读的清单：条目简短，新的在前，一项变化一条。发布说明是一份用来阅读的文档：它把一个版本里的变化归到一起，用截图解释较大的改动，并附上升级或迁移步骤。
小团队通常只需要更新日志，遇到值得多说的发布，就把那一条写长一些。有版本化安装包或 API 的产品往往还会另外发布说明，并让每条更新日志链接过去。
发布前的检查清单
把自己当成一位从没见过您路线图的用户，再读一遍。
- 只看标题，不看正文，看得懂吗？
- 第一句话讲的是用户，而不是团队吗？
- 该有数字、路径或截图的地方，有了吗？
- 如果是出了问题，有没有说清影响了谁、该怎么做？
- 它所回应的需求，链接上了吗？
- 提过需求的人会收到通知吗，还是只有碰巧来看的人才知道？
在 Kjerr 里发布这样的更新日志
Kjerr 的公告栏目就是一份更新日志，用的正是上面四个分类。文章支持标题、列表、链接和图片，可以引用它所回应的想法，发布时还可以给订阅者发邮件。
- 分类、按内容和日期搜索、表情回应和评论。
- 面向读者的、经过邮箱验证的邮件订阅。
- 关联的想法显示在文章下方；把它们改为 Shipped，投票者就会收到邮件。
- 您自己网站上的小组件在侧边面板里显示同样的公告，启动按钮上显示未读数。
常见问题，直接回答。
什么是更新日志？
更新日志（changelog）是一份带日期、按时间倒序排列的产品变化清单，写给使用产品的人看。每一条都说明变了什么、影响到谁，以及他们需要做什么（如果需要的话）。
更新日志和发布说明有什么区别？
更新日志是对每一项值得一提的变化的持续记录；发布说明是对某一次发布的完整说明。一条更新日志只有几句话。发布说明可以写满一页，带截图和升级步骤。不少产品把两者发在同一个地方。
一条更新日志应该包含什么？
一个说出变化的标题，一个分类，一两句话讲用户现在能做什么、去哪里找，以及需要用户做的事。如果这项变化回应了某条需求，就写出来，并链接过去。
更新日志应该多久更新一次？
只要有用户能察觉到的东西上线，就更新。每一两周一条简短的更新，比每个季度一篇长文更能建立信任。
更新日志应该放在哪里？
放在一个有独立网址的公开页面上，这样才能被链接、被搜索、被收录；同时用邮件发给订阅的人。Kjerr 把它和功能需求放在同一块看板上。
相关页面
给用户一个答复。
早期体验阶段，Kjerr 完全免费：包含全部功能，无需信用卡。日后推出付费套餐时，将按工作区计费，绝不按管理员席位计费。