实验记录与 README 模板

做 AI 项目时，代码只是作品的一部分。真正能体现能力的是：你为什么这样做，怎么验证，失败过什么，下一步怎么改。下面的模板可以直接复制到每个阶段项目 README。

项目 README 模板

# 项目名称

## 项目目标

这个项目解决什么问题？用户输入是什么，系统输出是什么？

## 运行方式

```bash
python main.py

示例输入输出

输入：

这里放一个真实输入

输出：

这里放系统输出

项目结构

project/
  main.py
  data/
  README.md

方法说明

用了什么数据、模型、工具或 API？为什么这样选？

评估方式

用什么指标判断效果？baseline 是什么？有没有错误样本？

遇到的问题

记录至少一个环境、数据、模型、接口或工程问题，以及你怎么排查。

下一步计划

下一版准备改什么？为什么？

## 实验记录模板

| 字段 | 内容 |
|---|---|
| 实验日期 | 例如 2026-04-26 |
| 实验目标 | 这次想验证什么 |
| 数据/输入 | 使用什么数据或样例 |
| 方法/配置 | 模型、Prompt、参数、工具版本 |
| 结果 | 指标、截图、输出样例 |
| 失败样本 | 哪些样本表现不好 |
| 结论 | 这次学到了什么 |
| 下一步 | 下一轮怎么改 |

## 错误样本记录模板

| 样本 | 预期结果 | 实际结果 | 可能原因 | 改进方向 |
|---|---|---|---|---|
| 示例 1 | 应该答 A | 实际答 B | 检索没命中 | 改 chunk 或 query rewrite |

## 为什么要坚持记录

如果你只保留最终代码，别人很难看出你的成长过程。记录实验、失败和改进，可以证明你不是只会跑 demo，而是能像工程师一样迭代系统。