# 项目名：一句话说清它是什么
> 员工手册问答助手 · 给公司文档做"带出处"的问答，答对率 86%

![demo](docs/demo.gif)   <!-- ① 顶部直接放效果 GIF，胜过千言万语 -->

## 它解决什么问题        <!-- ② 痛点 + 价值，2~3 句 -->
新员工找制度要翻 20 个 PDF。本项目让他们直接提问，秒答且给出处。

## 效果                  <!-- ③ 用数字说话（评测来的！Day62） -->
- 20 道常见问题答对率 **86%**，均带出处
- 单次回答 < 3 秒

## 快速开始              <!-- ④ 三行内能跑起来，别让人猜 -->
```bash
pip install -r requirements.txt
python ingest.py          # 摄入文档
uvicorn app:app           # 启动，浏览器打开 /docs 试问
```

## 架构                  <!-- ⑤ 一张流程图 + 关键取舍，展示你懂设计 -->
文档 → 切块 → 向量库 → 检索top-k → LLM生成(带出处)
## 技术栈 / 目录说明 / License   <!-- ⑥ 细节兜底 -->

# 提 PR 的标准流程（Day06 的 Git 技能派上用场）
# 1) 在 GitHub 网页点 "Fork"，把别人的仓库复制一份到你名下
git clone https://github.com/你的名字/项目.git   # 克隆你 fork 的那份
cd 项目
git checkout -b fix-typo-in-readme               # 开一个新分支干活（别在 main 上改）
# 2) 改点小东西：比如修 README 的一个错别字 / 补个示例
git add . && git commit -m "docs: fix typo in quickstart"
git push origin fix-typo-in-readme               # 推到你 fork 的仓库
# 3) 回 GitHub 网页，点 "Compare & pull request"，写清"改了啥、为什么"
# 4) 维护者可能提意见 → 按建议再改再 push → 合并！你就有第一个开源贡献了 🎉

✋ 动手 10 分钟：给作品①写好第一屏 README

打开作品① RAG 助手的 README.md,只写"第一屏"(最能决定去留的部分):

# 员工手册问答助手
> 给公司文档做"带出处"的智能问答 · 20 题答对率 86% · 单次 < 3s

<!-- 先占位，demo 录好后替换成真图 -->
![demo](docs/demo.gif)

## 它解决什么问题
新员工找制度要翻一堆 PDF；本项目让他们直接提问，秒答且标注出处。

## 快速开始
```bash
pip install -r requirements.txt
python ingest.py && uvicorn app:app
```

再列一个"包装 To-Do"贴在博客草稿里(课后逐项完成):① 三件作品各写第一屏 README ② 录一段 30 秒 demo GIF ③ 写一篇设计取舍博客 ④ 给一个开源项目提一个修文档的 PR ⑤ Pin 置顶 + 写 Bio。