Skip to content

封版清单

这一页不再讨论源码实现细节,而是把“当前版本能不能发”“发之前必须检查什么”“哪些问题可以留到下一轮”收成一张可执行 SOP。

当前判断

基于本仓库当前状态,这本书已经具备候选发布版基础,但只有在下面三类条件同时满足时,才应该进入封版判断:

  • 源码快照可信:章节解释与链接指向同一份源码基线
  • 主链路一致:首页、阅读地图、章节模板与实践入口没有结构漂移
  • 页面可验证:构建通过,关键页面可正常浏览,练习模板和源码快照卡显示正常

发布阻塞项

下面这些项只要有一项未完成,就不建议封版:

  • [ ] 全站默认源码链接策略已经统一为“commit 锚定优先,dev 仅作最新实现对照” 验证方式:检查 版本说明、首页入口文案和核心章节链接口径是否一致。

  • [ ] 首页、阅读地图、实践首页、中级篇导读的结构关系已经明确 验证方式:人工通读这 4 个入口页,确认三条主线没有互相打架或重复定义。

  • [ ] bun run build 可以稳定通过 验证方式:在 docs/book 目录执行一次完整构建,确认没有阻塞级错误。

  • [ ] 核心章节不存在明显草稿痕迹或作者备注 验证方式:搜索 TODO待补需要补充TBD占位 等关键词,并人工判断是否属于发布内容。

  • [ ] 源码快照卡、练习模板、lastUpdated 在抽查页面中正常显示 验证方式:至少抽查 /01-agent-basics//07-tui-interface//12-plugins-extensions/

非阻塞优化项

下面这些问题不一定阻止当前版本发布,但应进入下一轮优化计划:

  • [ ] 高价值章节内部的 GitHub 链接继续从 dev 逐步切到 commit 锚定
  • [ ] 首页和长文页做一轮移动端与长代码块排版检查
  • [ ] 主题层动画与大 chunk 警告进入专项优化
  • [ ] 术语表与正文做一次全站口径回收
  • [ ] 增加自动化检查脚本,减少人工抽查负担

发布前验证流程

建议按下面顺序执行,不要跳步:

第一步:跑自动与半自动检查

  1. 执行 bun run check:content
  2. 执行 bun run check:practice
  3. 执行 bun run build
  4. 确认构建完成且没有阻塞级错误
  5. 记录构建期间出现的非阻塞警告,进入下一轮优化列表

第二步:抽查关键入口页

按下面顺序人工通读:

  1. 首页
  2. 阅读地图
  3. 实践篇首页
  4. 中级篇导读
  5. 版本说明

检查重点:

  • 定位是否一致
  • 三条内容主线是否清楚
  • 入口按钮是否能把人带到正确页面
  • 源码基线说明是否和正文口径一致

第三步:抽查章节级体验

至少抽查下面这些页面:

  1. /01-agent-basics/
  2. /07-tui-interface/
  3. /12-plugins-extensions/

检查重点:

  • 顶部源码快照卡是否正常显示
  • 任务 / 操作 / 验收 模板是否排版正常
  • 最后更新于 是否显示真实更新时间
  • 页面顶部和底部导航是否可用

第四步:确认剩余问题归类

完成抽查后,把问题分成两类:

  • 阻塞项:必须修完才允许封版
  • 非阻塞项:记录到下一轮改进,不阻止当前版本发布

如果问题无法明确归类,默认按更保守的阻塞项处理。

当前已确认通过的事项

以下事项在最近一轮检查中已确认通过:

  • [x] 站点已启用真实 lastUpdated
  • [x] version-notes 已提供全书统一源码快照语义
  • [x] 全站可执行 bun run build
  • [x] bun run check:content 可通过
  • [x] bun run check:practice 可通过
  • [x] bun run typecheck 可通过
  • [x] bun run build:strict 可通过
  • [x] 章节页已接入统一源码快照卡与练习模板

当前建议

如果现在准备把这一版作为第一版电子书候选版,最稳妥的顺序是:

  1. 先把阻塞项全部打勾
  2. 再按验证流程走一遍
  3. 最后把剩余问题移入非阻塞优化项

满足这三步后,再决定是否正式封版,而不是反过来先决定“要不要发”,再临时补检查。