变更日志哲学
💡
原文英文，约700词，阅读约需3分钟。
📝
内容提要
文章讨论了变更日志和发布说明的重要性，强调变更日志应关注用户所需信息，而非内部变更。Sumana建议分别制作变更日志和用户导向的发布说明，以提供更全面的信息。作者倾向于结合两者，制作手写的变更日志，关注用户需求，同时考虑维护者的精力和用户的注意力。最终，每个项目应根据自身情况平衡工作量和收益。
🎯
关键要点
- 变更日志应关注用户所需的信息，而非内部变更。
- 建议分别制作变更日志和用户导向的发布说明，以提供更全面的信息。
- 发布说明可以包含项目级的信息，如新讨论论坛的启动或维护者关注的变化。
- 将变更日志和发布说明分开可能会增加维护者的工作量，而用户的注意力有限。
- 每个项目应根据自身情况平衡工作量和收益，考虑其受众和资源。
- 在变更日志中，描述修复的错误和重要的行为变化，并链接到新文档和贡献者。
❓
延伸问答
变更日志和发布说明有什么区别？
变更日志关注每个非琐碎的变更，而发布说明则更侧重于用户所需的信息和项目级的变化。
为什么变更日志应关注用户所需的信息？
因为用户需要了解对他们有影响的变化，而不是内部的技术细节，这样才能更好地使用产品。
如何平衡变更日志和发布说明的制作工作量？
每个项目应根据自身情况评估受众和资源，找到适合的工作量与收益的平衡点。
发布说明可以包含哪些类型的信息？
发布说明可以包含项目级的信息，如新讨论论坛的启动、维护者关注的变化等。
在变更日志中应该包含哪些信息？
变更日志应描述修复的错误、重要的行为变化，并链接到新文档和贡献者。
如何提高用户对变更日志的关注度？
可以通过手写变更日志，专注于用户需要的信息，并在结尾总结未提及的变化，提供链接到git历史。
➡️
