项目 README 模板
项目 README 模板
Section titled “项目 README 模板”README 是项目入口，回答”这个项目是什么、怎么运行、现在什么状态”。它写给三个月后的你看，也写给第一次打开项目的人看。
README 可以让 AI 起草，但三样东西必须由你补上：真实运行方式、真实踩坑点、真实当前状态。AI 会按文件猜，猜错的地方你要试出来。
让 AI 生成草稿
Section titled “让 AI 生成草稿”请读取当前项目，先说明你看到的文件结构和项目用途。请区分你确定看到的内容和你根据文件名推测的内容。确认读对后：
请基于当前项目生成一份 README 草稿。包含：项目用途、运行方式、文件结构、当前功能、注意事项、后续计划。语言用大白话，写给三个月后的我看。# 项目名
一句话说明这个项目做什么、给谁用。
## 运行方式
- 环境要求：（需要的软件/版本）- 启动步骤： 1. ... 2. ...
> 必须自己实际跑过一遍，按真实步骤写。
## 文件结构
```txt项目根目录/├─ index.html # 入口页面├─ data/ # 数据文件└─ README.md # 本文件- 已完成的
- 还没做的
- 真实踩过的坑 1
- 真实踩过的坑 2
- 1 到 3 条下一步
## 验证 README 是否合格
最简单的检查：**照着 README 能不能把项目跑起来**。
如果跑不起来，把实际情况反馈给 AI：
```txt我按 README 的运行方式操作，没有看到预期结果。实际情况是：（描述）请帮我判断 README 哪一句需要修正。- AI 把运行方式写错：自己实际试一次再写。
- 文件结构太粗：列出具体文件名和用途。
- 注意事项太空：写自己刚才踩过的坑。
- 项目写得太”已完成”：改成真实当前状态。
- 没有下一步：补 1 到 3 条后续计划。