外观
更新日志
更新日志不是学习章节,而是维护记录入口。它帮助读者和维护者快速看清:最近改了什么,为什么改,影响哪些章节,检查是否通过。
如果你只是学习教程正文,不需要从这里开始;如果你要确认某一版内容为什么变化,或者要接着维护文档,就从这里看。
查看入口
先看什么
| 你想确认什么 | 看哪里 |
|---|---|
| 最近一次改了哪些内容 | 更新日志顶部最新日期 |
| 某次重构影响哪些章节 | 每条记录里的“涉及位置” |
| 修改后有没有做基础检查 | 每条记录里的“检查情况” |
| 后续维护要接什么任务 | 记录里的遗留说明或后续关注点 |
记录原则
- 更新日志写给人看,不只写提交号。
- 每次准备提交前,先记录本次修改的原因、范围和检查结果。
- 只记录对教程内容、结构、工具或维护规则有影响的变化。
- 临时构建产物、缓存和本地预览文件不写进更新日志。
