docs: 完善README使用方法 — 快速开始 + 一键速查 + 逐文件审查流程

2026-09-26 23:11:51 +08:00 · 2026-06-18 19:47:21 +08:00
parent dfa3a585c5
commit 76a230a679
1 changed files with 38 additions and 31 deletions
@@ -39,39 +39,46 @@ npm run package

 ## 使用方法

-### 工作流程
+### 快速开始
+
+1. **安装插件** → 重启 VSCode → 状态栏左侧出现 `$(diff) AI Diff`
+2. **用 Claude Code / Cursor 对话** → 每次 Edit/Write **自动静默收集**，不打断工作流
+3. **对话结束 (Stop)** → 自动弹出 **QuickPick 总览**，列出所有变更文件
+4. **↑↓ 键选择文件** → 回车打开 **VSCode 内置 Diff 编辑器**，左侧原始代码、右侧变更后
+5. **查看状态栏右侧** → 三个彩色按钮：`✓ Accept` `✗ Reject` `✓✓ 接受此文件全部`
+6. **点击 Accept / Reject** → 变更立即应用到磁盘 → **自动推进**到下一个文件
+7. **全部处理完** → 🎉 通知，状态栏回到常态
+
+### 一键操作速查
+
+| 操作 | 方法 |
+|------|------|
+| 接受**全部文件的所有变更** | QuickPick 底部选 `✅ Accept All`，或 `Ctrl+Shift+A` |
+| 拒绝**全部文件的所有变更** | QuickPick 底部选 `❌ Reject All`，或 `Ctrl+Shift+R` |
+| 手动打开总览 | 点击状态栏 `$(diff) AI Diff`，或 `Ctrl+Shift+D` |
+| 查看当前文件 Diff | `Ctrl+Shift+F` |
+| 在变更文件间导航 | `Alt+↑` / `Alt+↓` |
+| 接受当前编辑 | `Tab`（需要在 Diff 编辑器内） |
+
+### 逐文件审查流程

 ```
-┌─────────────────────────────────────────────────────────┐
-│ AI 对话中（Claude Code / Cursor / Copilot）               │
-│                                                         │
-│ Edit/Write 工具调用 → .claude/hooks/pending.json          │
-│                      → 插件自动收集变更 (静默)            │
-│                                                         │
-│ Stop/对话结束 → QuickPick 总览弹窗                        │
-│              ┌──────────────────────────────────────┐   │
-│              │ AI Diff 总览 — 3 文件 5 编辑          │   │
-│              │                                      │   │
-│              │ 📄 src/utils.ts  +3 -2 · 2次编辑     │   │
-│              │ 📄 src/index.ts  +9 -1 · 2次编辑     │   │
-│              │ 📄 src/types.ts  +5 -0 · 1次编辑     │   │
-│              │ ────────────────────────────────     │   │
-│              │ ✅ Accept All    ❌ Reject All       │   │
-│              └──────────────────────────────────────┘   │
-│                ↓ 点击文件                                │
-│              ┌──────────────────────────────────────┐   │
-│              │ VSCode 内置 Diff 编辑器               │   │
-│              │ ┌──── 原始代码 ──┬── 变更后 ────┐    │   │
-│              │ │ ...           │ ...          │    │   │
-│              │ └───────────────┴──────────────┘    │   │
-│              │                                     │   │
-│              │ 状态栏: [✓ Accept] [✗ Reject]      │   │
-│              │         [✓✓ 接受此文件全部]         │   │
-│              └──────────────────────────────────────┘   │
-│                ↓ Accept/Reject                          │
-│              → 自动推进到下一个文件/同文件剩余编辑       │
-│              → 全部完成: 🎉 通知                        │
-└─────────────────────────────────────────────────────────┘
+AI 对话进行中（静默收集 EditRecord）
+    │
+Stop → QuickPick 弹窗
+    │
+    ├─ 📄 file1.ts  +3 -2 · 2次编辑     ← 选中回车
+    │     │
+    │     └→ VSCode 内置 Diff 打开
+    │          状态栏右侧: [✓ Accept] [✗ Reject] [✓✓ 接受全部]
+    │          点击 ✓ → 应用变更
+    │             ├→ 同文件还有待处理编辑? → 重新打开此文件 Diff
+    │             └→ 文件处理完毕? → 自动打开下一个文件 Diff
+    │
+    ├─ 📄 file2.ts  +9 -1 · 1次编辑     ← 自动推进
+    │     └→ ... (重复)
+    │
+    └─ 🎉 所有变更已处理完毕
 ```

 ### 快捷键