如何更新这本笔记

本页回答三个日常问题：学完一天怎么记录？学习笔记怎么写？这本书怎么更新？ 心智模型：GitHub 仓库 = 书的源稿；GitHub Pages = 出版的成品；git push = 再版。每次 push 后约 1–2 分钟，线上自动更新。

一、每日更新 SOP（5 分钟）

当天学完（哪怕只有 30 分钟），做三件事：

1. 速记：打开 学习日志，找到本周（W__）条目，在「完成了什么」下追加一行当日进展；有卡点就记进「卡点与解决」。
2. （可选）笔记：如果当天形成了值得沉淀的内容（概念想通了/踩了坑/有代码片段），在 notes/ 新建一篇，文件名 W__-主题.md（如 W1-tokenizer-直觉.md），用笔记模板。
3. 提交推送：

git add .
git commit -m "log: W1 D3 流式助手完成，卡在 stream 分块"
git push

推送后 GitHub Actions 自动重新出版这本书（Actions 页可看进度，约 1–2 分钟）。不写笔记也没关系，速记一行 + push 的习惯比写得完美重要——8 周后回看，绿色的 commit 方格就是你的学习心电图。

commit 信息约定

前缀	用途	示例
log:	学习日志更新	log: W1 D3 完成流式助手
note:	新增/修改笔记	note: W1 tokenizer 直觉
docs:	计划/指南/资源文档调整	docs: 修正 W2 工具清单
chore:	构建、配置等杂务	chore: 升级 mkdocs-material

二、每周日 SOP（30–60 分钟）

1. 信息雷达扫描 30 分钟：按 资源雷达 的扫描 SOP 走，发现记进周记「雷达发现」区
2. 周记定稿：补全本周周记的所有字段（投入时间/关键认知/卡点/数据/验收清单打勾）
3. 发布笔记：本周笔记整理成 1 篇公开文章发到博客/知乎/掘金（书里保留原文，文末互加链接）
4. 翻状态牌：把 路线图 中本周状态从 ⬜ 改为 ✅（或 🔄）
5. 提交推送：git commit -m "log: W1 周记定稿" && git push

三、每月末 SOP（月末的周日）

1. 用学习日志里的月度复盘模板写复盘
2. 更新路线图：当月各周状态、行业变化日志（雷达月度汇总）
3. 检查 资源清单：死链更新、失效淘汰
4. 检查 知识库 的 🔴 易变页（主要是模型格局页）：按其「核查 SOP」花 5 分钟核实，刷新「最后核实」日期；有新概念学完则解锁写一篇 L2/L3 页
5. 提交推送

四、写笔记的规范

• 文件名：W__-主题.md，小写、连字符、英文或中文主题均可
• 结构：用笔记模板——一句话主旨、概念卡（自己的话）、动手记录、卡点与解法、引用链接
• 质量标准：写给三个月后的自己和完全不懂的读者——两三个月后还能看懂、外人能学到东西
• 发布：书内是底稿，同步发布到 1 个外部平台（知乎/掘金/博客任选），书内文末注明「发布于 xx，链接 xx」，外部文末注明「本文收录于 agent_harness 学习之书」
• 源码笔记（W6–7 起）用 Codex 指南里的专用模板

五、本地预览（改完想先看效果再 push）

# 首次：安装依赖（用 py 启动器调系统 Python；会建 .venv 虚拟环境，已被 .gitignore 排除）
py -m venv .venv
.venv\Scripts\pip install -r requirements.txt

# 预览：浏览器打开 http://127.0.0.1:8000，改动实时刷新
.venv\Scripts\mkdocs serve

六、维护备忘

• 学习日志是单文件追加制；若超过 1000 行或进入第 3 个月，届时拆分为 log-2026-09.md 等按月文件（到时再定，现在不做）
• 新增章节页面后，记得在 mkdocs.yml 的 nav 里登记，否则不出现在目录里
• .env（API key）和 site/（构建产物）永远不进 git——.gitignore 已配置，勿删