L25. 编写文档：把你的作品卖出去

Vibe Coding 宣言：没有文档的代码，就像没有说明书的宜家家具。

0. 为什么这一课至关重要？ (Why It Matters)

• 遗忘曲线：相信我，一周后你就看不懂自己写的代码了。
• 团队协作：别人接手你的代码，如果没有文档，他会想杀了你。
• 求职利器：HR 看到你的 GitHub 有漂亮的 README，印象分直接拉满。

1. 目标 (Goal)

学会使用 Markdown 编写专业的 README.md，并生成 requirements.txt。

2. 核心概念/装备/指令 (The Core)

2.1 README.md (The Face)

项目的门面。必须包含：

• What: 这是啥？
• Why: 解决了啥问题？
• How: 怎么跑起来？

2.2 requirements.txt (The Dependency)

告诉别人要装哪些包。

• pip freeze > requirements.txt: 导出当前环境所有包。

3. 实战演练 (Action)

Step 1: 导出依赖

pip freeze > requirements.txt

Vibe Tip: 最好手动筛选一下，把那些系统自带的杂七杂八删掉，只保留你用到的核心包（如 pandas, requests, streamlit）。

Step 2: 让 Claude 写 README

把你的代码结构喂给 Claude：

# Context
这是我的项目文件列表 [粘贴 ls 输出]。
核心功能是 [描述]。

# Task
请帮我生成一份专业的 `README.md`。
包含：
1. 项目简介 (Project Overview)
2. 安装指南 (Installation)
3. 快速开始 (Quick Start)
4. 环境变量配置 (.env example)
5. 许可证 (License - MIT)

Step 3: 添加徽章 (Badges)

让 README 看起来更专业。去 Shields.io 找几个徽章贴上去。 ![Python](https://img.shields.io/badge/python-3.10-blue)

4. 常见问题 (FAQ - Vibe Style)

Q: 文档要写多细？ A: 只要写“怎么跑起来”就行。 没人在意你的实现细节，大家只关心怎么用。

Q: 只有英文文档显得高大上吗？ A: 是的。 但如果你的用户是中国人，请写中文。或者中英双语。

Q: 更新了代码忘了更文档？ A: 这是常态。 所以尽量把文档写得通用一点，少写那些容易变的细节。

5. 验收标准 (Definition of Done)

1. 根目录下有 README.md。
2. README.md 里有清晰的安装步骤 (pip install -r requirements.txt)。
3. 有一个可以照着做的 .env.example。
4. 模块四结业：你的项目现在是一个完整的产品了，可以交付给用户了。

---

Next Mission: L26. 云端部署基础：把代码送上天