ChangeLog应该怎么写？ – 半撇有道儿

在工作当中, 需要去撰写非常多的课程类型的文档。因为这些内容会随着不断的迭代而发生持续性的演变。等到时间过久了之后, 就很可能会把过去究竟是在什么时间节点上做过的哪些改动全都忘记掉。所以在面临这种状况的时候, 就必须要由负责编写这份文档的人员主动地保持对文档内容的最新状态的维护与更新。目的是为了能够起到保证的作用, 也就是确保每一位参与协作的成员都始终处于同一个前进的步伐节奏之中, 避免出现信息不同步带来的问题。很多人认为更新日志似乎是仅有专职进行代码编写工作的人员才需要去准备的一份文本材料, 然而, 只要是存在文档协同编辑的行为,或者是对单一文档展开长期的持续迭代活动, 我们都必须有着一份能够用来留存历史变更信息的修订记录文档, 借此方式能使后来加入该团队的新成员, 对整件事情的来龙与去脉取得一处极其具直观性质的认知体验。什么是更新日志请问什么是所谓的更新日志呢? 这个更新日志, 或者说叫做Log的东西, 其实是一个采用倒序的时间排列方式来呈现的列表形式, 该列表的内容完全是依赖于人工进行编辑加工的, 它的核心作用在于将每一个具体版本里面所发生的重大的那些变动情况全部都逐一记录清楚。现在我们呢就来看一看那个比较直观的具体的案例哈。# Change LogAll notable changes to this project will be documented in this file.The format is based on [Keep a Changelog](http://keepachangelog.com/)and this project adheres to [Semantic Versioning](http://semver.org/).## [Unreleased]### Added- zh-CN and zh-TW translations from tianshuo.- de translation from mpbzh.- it-IT translation from roalz.- sv translation from magol.- tr-TR translation from karalamalar.- fr translation from zapashcanon.### Changed- Start versioning based on the current English version at 0.3.0 to helptranslation authors keep things up-to-date.- Fix typos in zh-CN translation.- Fix typos in pt-BR translation.## [0.3.0] - 2015-12-03### Added- RU translation from aishek.- pt-BR translation from tallesl.- es-ES translation from ZeliosAriex.## [0.2.0] - 2015-10-06### Changed- Remove exclusionary mentions of open source since this project can benefitboth open and closed source projects equally.## [0.1.0] - 2015-10-06### Added- Answer Should you ever rewrite a change log?.### Changed- Improve argument against commit logs.- Start following [SemVer](http://semver.org) properly.## [0.0.8] - 2015-02-17### Changed- Update year to match in every README example.- Reluctantly stop making fun of Brits only, since most of the worldwrites dates in a strange way.### Fixed- Fix typos in recent README changes.- Update outdated unreleased diff link.## [0.0.7] - 2015-02-16### Added- Link, and make it obvious that date format is ISO 8601.### Changed- Clarified the section on Is there a standard change log format?.### Fixed- Fix Markdown links to tag comparison URL with footnote-style links.## [0.0.6] - 2014-12-12### Added- README section on yanked releases.## [0.0.5] - 2014-08-09### Added- Markdown links to version tags on release headings.- Unreleased section to gather unreleased changes and encourage notekeeping prior to releases.## [0.0.4] - 2014-08-09### Added- Better explanation of the difference between the file (CHANGELOG)and its function the change log.### Changed- Refer to a change log instead of a CHANGELOG throughout the siteto differentiate between the file and the purpose of the file — thelogging of changes.### Removed- Remove empty sections from CHANGELOG, they occupy too much space andcreate too much noise in the file. People will have to assume that themissing sections were intentionally left out because they contained nonotable changes.## [0.0.3] - 2014-08-09### Added- Why should I care? section mentioning The Changelog podcast.## [0.0.2] - 2014-07-10### Added- Explanation of the recommended reverse chronological release ordering.## 0.0.1 - 2014-05-31### Added- This CHANGELOG file to hopefully serve as an evolving example of a standardized open source project CHANGELOG.- CNAME file to enable GitHub Pages custom domain- README now contains answers to common questions about CHANGELOGs- Good examples and basic guidelines, including proper date formatting.- Counter-examples: What makes unicorns cry?[Unreleased]:[0.3.0]:[0.2.0]:[0.1.0]:[0.0.8]:[0.0.7]:[0.0.6]:[0.0.5]:[0.0.4]:[0.0.3]:[0.0.2]:为什么要进行更新日志的更新?简单来说, 咱们得弄出一个能让大伙儿都看明白的东西, 这个是为了让一起干活的人, 尤其是在对着同一篇文档使劲儿的那种情况下, 更直接地去晓得每一个版本里头, 到底是有了哪些不一样的地方。如何写好更新日志关于什么是更新日志这个问题已经得到了明确, 同时也清楚知道为什么需要更新日志, 我觉得更关键的地方在于应该如何把一篇更新日志给写好。这是一个正在努力使得更新日志变得规范有序的项目, 在它的官方网站上头, 它曾经提到过一些情况:看起来GNU或者GNU NEWS曾经提过一些规范, 但是事实情况是, 它们显得太过简陋。考虑到开发存在的多种多样情况来说, 要是采用那样的规范的话, 确实会显得不太合适。因此, 那个项目的发起人他觉得以前的世界标准还不够好, 不够优质, 所以他自个儿搞了一份对应的规范, 然后把这个规范给发布上去了, 在里头他是这么定义什么叫做一份优秀的更新日志的。另外, 关于命名规范这一事项, 他也给出来了建议, 也就是直接把更新日志命名为.md这种形式, 请大家务必注意其中的大小写问题。你看那些个文件名, 像是说.txt还有.md, 然后又是NEWS点txt, 接着是NEWS点md, 再往后瞅, 还是News点txt, 最后又回到开头那种.txt和两个不同的.md文件, 这摆明了就是太不统一了。