LESSON_TEMPLATE.md实战：为ai-engineering-from-scratch编写符合规范的新课程

LESSON_TEMPLATE.md实战为ai-engineering-from-scratch编写符合规范的新课程【免费下载链接】ai-engineering-from-scratchLearn it. Build it. Ship it for others.项目地址: https://gitcode.com/GitHub_Trending/ai/ai-engineering-from-scratch在开源课程项目ai-engineering-from-scratch500 课时、20 个学习阶段的 AI 工程体系课程中每门新课都必须遵循仓库根目录的 LESSON_TEMPLATE.md 模板编写。本文带你从零走通「一键脚手架 → 写文档 → 写代码 → 产出可复用资产 → 通过审计」的完整流程让你的贡献一次性符合项目规范。一、认识 LESSON_TEMPLATE.md新课的施工图LESSON_TEMPLATE.md 定义了每个课程目录的标准结构——代码、文档、资产各归其位NN-lesson-name/ ├── code/ 可运行的实现main.py / main.ts / main.rs / main.jl ├── notebook/ 用于动手实验的 Jupyter notebook ├── docs/ │ └── en.md 课程文档必需 └── outputs/ 课程产出的 prompt / skill / agent 等资产 这个结构是硬性约定仓库的审计脚本 scripts/audit_lessons.py 会逐目录校验文件名正则NN-kebab-case、文档最小长度、quiz 键名等不变量结构不对直接报问题。二、用 scaffold-lesson.sh 一键生成课程骨架不用手动建目录。仓库提供了脚手架脚本 scripts/scaffold-lesson.sh在仓库根目录执行scripts/scaffold-lesson.sh 05-nlp-foundations-to-advanced 20-attention-visualization脚本会自动完成三件事创建code/、notebook/、docs/、outputs/四个子目录从 LESSON_TEMPLATE.md 预填一份docs/en.md文档骨架标题自动从课程名生成生成code/main.py占位实现并打印后续步骤清单。脚本还内置了校验阶段目录不存在、课程目录已存在、或课程名不匹配NN-kebab-case格式时都会直接报错退出把问题挡在提交之前。三、docs/en.md六段式课程文档写法模板规定的文档结构是这套课程最大的特色——先建立心智模型再写代码最后产出资产章节要写什么写作要点The Problem没有这个知识你卡在哪里2-3 段场景要具体The Concept概念与直觉只用图表和表格先不出现代码Build It从零分步实现每个代码块必须能独立运行Use It框架是怎么做的对比手写版与库版本Ship It本课产出什么可复用资产资产存入outputs/Exercises / Key Terms三道递进练习 术语纠偏表易→中→难术语表写大众误解 vs 真实定义文首还要求一行motto一句话核心思想和元信息Type、Languages、Prerequisites、Time让读者 5 秒内判断这门课适不适合自己。四、代码文件四条硬规则模板对code/里的实现代码要求极简✅ 代码必须无错误可直接运行✅ 不写注释——代码应自解释✅ 有依赖就提供requirements.txt✅ 从最简单版本起步逐步加复杂度。想看看达标是什么样可以参考已完成的课程 phases/05-nlp-foundations-to-advanced/03-word-embeddings-word2vec/code/main.py从零手写 Word2Vec 的训练与向量探测文档在 phases/05-nlp-foundations-to-advanced/03-word-embeddings-word2vec/docs/en.md。五、Ship It给 outputs/ 写一份带元数据的资产每门课应该交付一样东西一个 prompt、一个 skill、一个 agent 或 MCP server。模板规定了 frontmatter 元数据格式例如 skill 类资产--- name: embedding-probe description: 检查 word2vec 模型跑类比测试 version: 1.0.0 phase: 5 lesson: 03 tags: [nlp, embeddings, debugging] ---仓库顶部的 outputs/ 目录会收录这些资产。参考真实样例phases/05-nlp-foundations-to-advanced/03-word-embeddings-word2vec/outputs/skill-embedding-probe.md——一份教读者如何探测词向量模型质量的完整 skill。六、收尾更新 ROADMAP 并通过审计课程写完还有两步收尾详见 CONTRIBUTING.md在 ROADMAP.md 对应阶段表格中加一行格式固定为| 03 | 课程名 | ✅ | ~75 min |。注意状态符号✅ / / ⬚是网站解析器识别的不能用文字替代跑一遍审计python scripts/audit_lessons.py它检查目录命名、文档完整性、quiz.json 键名stage/question/options/correct/explanation等退出码 0 才算干净。⚠️ 特别提醒如果你的改动触碰了 README/ROADMAP编辑后要重新生成网站数据确保site/data.js只有时间戳变化——这是 CONTRIBUTING.md 中结构性安全的要求。七、速查清单 ✅步骤命令 / 文件验收标准1. 生成骨架scripts/scaffold-lesson.sh4 个子目录 en.md 骨架2. 写文档docs/en.md六段式齐全motto 一行3. 写代码code/main.py直接可运行、无注释4. 产资产outputs/skill-*.mdfrontmatter 元数据完整5. 更新路线ROADMAP.md表格行格式正确6. 跑审计python scripts/audit_lessons.py退出码为 0按照这套流程走一遍你的新课就能像 phases/05-nlp-foundations-to-advanced/03-word-embeddings-word2vec/ 一样同时拥有文档、代码、资产和 quiz顺利并入这 500 课时的课程体系中。【免费下载链接】ai-engineering-from-scratchLearn it. Build it. Ship it for others.项目地址: https://gitcode.com/GitHub_Trending/ai/ai-engineering-from-scratch创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考