README 是什么？
08-01 README 是什么？
Section titled “08-01 README 是什么？”这一课讲 README。
项目能跑起来以后，学员很容易只关注页面或脚本本身。几天后再打开项目，他可能忘记怎么运行、文件分别做什么、上次做到哪一步。
README 就是项目入口，是写给未来自己的说明。它让未来的自己、老师、同伴和 AI 都能快速理解这个项目。
- 让学员知道 README 的用途。
- 让学员知道 README 应该回答哪些问题。
- 让学员理解 README 和工作日志的区别。
- 让学员会写最小 README。
- 让学员完成一份 README 问题清单。
- 建议时长：22 到 30 分钟。
- 对比一个没有 README 的项目和一个有 README 的项目。
- 先讲 5 个核心问题。
- 不追求格式复杂。
- 用“门口说明牌”讲 README，用“施工记录”讲日志。
可以这样开场：
“今天的你很清楚这个项目怎么跑。三个月后的你打开文件夹，可能会像打开别人留下来的东西。README 就是写给未来自己的信。”
README 至少回答五个问题。
第一，这个项目做什么。
“一句话说清楚项目用途。比如：这是一个个人主页第一版，用来展示个人介绍、联系方式和作品入口。”
第二，怎么运行。
“别人打开项目后，第一件事就是想知道怎么看到结果。网页项目可以写：用浏览器打开 index.html。如果需要命令，也要写清楚命令。”
第三，文件结构是什么。
“文件很多时，README 要告诉未来的自己每个文件大概负责什么。”
第四，当前完成了什么。
“项目不一定完整，但要说清当前状态。比如：页面能打开，标题区域和联系方式已经完成，作品卡片以后再做。”
第五，有哪些注意事项。
“你踩过的坑，就是未来的自己最需要的提醒。比如图片要放在 assets 文件夹，修改样式后要刷新浏览器。”
举例：
# demo-site
这是一个个人主页第一版。
运行方式：用浏览器打开 index.html。
文件结构：- index.html：页面结构- style.css：页面样式- script.js：简单交互
当前功能：展示个人介绍、联系方式和按钮。
注意事项：图片文件放在 assets 文件夹。这里要讲 README 和工作日志的区别：
“README 像门口说明牌，告诉你这个项目怎么进。工作日志像施工记录，告诉你今天做了什么。README 更稳定，日志更具体。”
可以加一个判断方法：
- 项目入口、运行方式、核心说明，放 README。
- 今天改了什么、遇到什么报错、下一步做什么，放工作日志。
最后收束：
“README 写清楚，未来的自己就能少花很多时间重新找路。AI 下次接手项目时，也能先读 README，再开始干活。”
屏幕演示流程
Section titled “屏幕演示流程”- 打开一个缺少 README 的项目，让学员感受信息缺口。
- 打开一个有 README 的项目，对比差异。
- 列出 README 五个核心问题。
- 在
demo-site中创建 README。 - 写入项目用途、运行方式、文件结构、当前功能、注意事项。
- 让 AI 读取 README，并复述项目入口。
- 人工检查 AI 复述是否准确。
让学员为自己的项目回答五个问题：
- 项目做什么。
- 怎么运行。
- 文件结构是什么。
- 当前功能是什么。
- 注意事项是什么。
练习完成后，让 AI 检查：
这是我的 README 草稿。请帮我判断未来的自己是否能照着它打开项目。如果不清楚，请只指出最关键的 3 个缺口。- README 写太长：先回答五个问题。
- 运行方式没试过：按 README 实际跑一遍。
- 文件结构写不清：让 AI 读取项目后先整理。
- 注意事项遗漏：把自己踩过的坑写进去。
- README 和日志混在一起：稳定入口放 README，当天过程放日志。
为当前项目写一份最小 README，并按里面的运行方式试一次。
补充要求：
- 写清项目用途。
- 写清运行方式。
- 写清文件结构。
- 写清当前状态。
- 写清至少 1 条注意事项。
- 第 1 页：标题“README 是写给未来自己的信”
- 第 2 页：项目做什么
- 第 3 页：怎么运行
- 第 4 页：文件结构
- 第 5 页：当前功能
- 第 6 页：注意事项
- 第 7 页：README 和工作日志