怎么让 AI 生成 README 草稿？
08-02 怎么让 AI 生成 README 草稿？
Section titled “08-02 怎么让 AI 生成 README 草稿？”这一课把 README 和 AI 协作结合起来。
上一课学员知道 README 应该回答哪些问题。这一课让 AI 读取项目，先生成一版 README 草稿，然后由学员补充真实经验和注意事项。
这一课要让学员形成一个判断：README 可以让 AI 起草，真实运行经验必须由人补上。
- 让学员会让 AI 读取项目并生成 README 草稿。
- 让学员知道 README 需要人工补充真实注意事项。
- 让学员会按 README 运行项目进行验证。
- 让学员会修正 AI 写错或写泛的内容。
- 让学员完成一份可用 README。
- 建议时长：25 到 35 分钟。
- 用真实项目生成 README。
- 生成后一定要人工修改。
- 最后按 README 运行一次项目。
- 要展示“AI 写错运行方式”时怎么纠正。
可以这样开场：
“README 很适合交给 AI 起草，因为 AI 可以读取项目文件，整理文件用途和运行方式。但最后那部分真实经验，要由你补上。”
先让 AI 读取项目：
请读取当前项目，先说明你看到的文件结构和项目用途。请区分你确定看到的内容和你根据文件名推测的内容。确认 AI 读到项目后，再让 AI 生成 README：
请基于当前项目生成一份 README 草稿。包含：项目用途、运行方式、文件结构、当前功能、注意事项、后续计划。语言用大白话，写给三个月后的我看。拿到草稿后，不能直接收工。
学员要补三类内容。
第一，真实运行方式。
“自己实际怎么打开项目，就怎么写。网页项目可能是双击 index.html，也可能要先运行本地服务。AI 可能根据文件猜运行方式，所以要人工试。”
第二，真实坑点。
“刚才页面没变化、CSS 没生效、打开错文件，这些都可以写进注意事项。真实坑点是 README 最有价值的部分。”
第三，真实状态。
“哪些功能已经完成，哪些内容以后再做。不要让 README 写得像项目已经全部完成。”
然后按 README 跑一遍。
“README 写得好不好，最简单的检查方式是：你照着它能不能把项目跑起来。”
如果跑不起来，直接修 README：
我按 README 的运行方式操作，没有看到预期结果。实际情况是：请帮我判断 README 哪一句需要修正。最后收束：
“AI 可以帮你把项目说明整理出来，你要把真实使用经验写进去。这样 README 才能真正服务未来的自己。”
屏幕演示流程
Section titled “屏幕演示流程”- 打开
demo-site。 - 让 AI 读取项目文件结构。
- 人工核对 AI 是否读对。
- 让 AI 生成 README 草稿。
- 人工补充真实注意事项。
- 按 README 运行项目。
- 根据验证结果修正 README。
- 让 AI 再读最终 README，并判断是否清楚。
- 保存最终 README。
让学员对自己的项目完成：
- AI 读取项目。
- AI 生成 README 草稿。
- 人工补充注意事项。
- 按 README 运行项目。
- 修正 README。
练习要求：
- 运行方式必须实际试过。
- 注意事项至少写 1 条真实踩坑。
- 后续计划只写 1 到 3 条。
- AI 写错运行方式：按步骤实际试一次。
- 文件结构说明太粗：让 AI 列出具体文件名和用途。
- 注意事项太空：写自己刚才踩过的坑。
- README 没有下一步：补一个“后续计划”。
- AI 把项目写得太完整：人工改成真实当前状态。
提交最终 README，并附一张按 README 运行成功的截图。
补充要求：
- README 能让未来的自己打开项目。
- README 写清当前状态。
- README 写清真实注意事项。
- 保存 AI 检查 README 的结果。
- 第 1 页：标题“让 AI 起草，让经验落地”
- 第 2 页：读取项目
- 第 3 页：生成 README 草稿
- 第 4 页：人工补充真实注意事项
- 第 5 页：照着 README 跑一次
- 第 6 页：修正并保存
- 第 7 页：让 AI 再检查