CS336课程笔记生成工作流

本目录包含了在创建 CS336 课程笔记过程中总结的通用方法论和最佳实践。

文档列表

| 文档 | 描述 | 适用场景 | |------|------|----------| | 01-资料搜集与验证 | 如何高效搜索、评估和验证信息来源 | 开始写笔记前的调研阶段 | | 02-笔记结构设计 | 如何组织文件结构、设计内容层级 | 创建新笔记时的规划阶段 | | 03-图片资源管理 | 如何获取、验证、管理图片资源 | 处理图片引用和本地化 | | 04-技术内容写作 | 如何写出清晰易懂的技术内容 | 实际写作过程中 | | 05-版本控制与协作 | 如何使用 Git 管理笔记项目 | 全程记录和多人协作 | | 06-问题排查与修复 | 如何定位和修复常见问题 | 遇到链接失效、格式错误时 |

使用建议

新手入门

1. 先阅读 01-资料搜集与验证 了解如何找到可靠信息
2. 再阅读 02-笔记结构设计 规划笔记结构
3. 写作时参考 04-技术内容写作

遇到问题时

1. 图片问题 → 03-图片资源管理
2. 链接失效 → 06-问题排查与修复
3. 版本回滚 → 05-版本控制与协作

核心原则概览

| 技能 | 核心原则 | |------|----------| | 资料搜集 | 可靠性 > 数量 | | 笔记结构 | 渐进式深入 | | 图片管理 | 本地化优先 | | 技术写作 | 讲故事，不堆砌 | | 版本控制 | 小步快跑，频繁提交 | | 问题排查 | 先定位，再修复 |

持续改进

这些技能文档会随着实践不断更新。如果你有更好的方法或发现了问题，欢迎补充！

---

最后更新: 2026-01-11