你如何向AI助手描述一个bug，以便它能准确诊断？

Question

Accepted Answer

向AI报告好bug与向人类报告好bug相同：给它**足够的context来在脑海中重现问题**，并消除噪音。AI只能对你粘贴的内容进行推理——模糊的描述会产生模糊的猜测。

## 应该包括的内容

- **确切的错误消息和完整的stack trace** — 逐字复制，而不是释义。trace中的文件和行号是最有用的线索。
- **相关的代码** — throw的函数及其直接调用者，而不是整个repo。
- **预期与实际行为** — "我期望X，但我得到Y"是任何bug报告的核心。
- **复现步骤** — 触发它的确切输入或序列。
- **环境/版本** — language、framework和library版本（bug可能是版本特定的）。
- **DB schema或示例数据** — 当bug涉及query或数据结构时。

## 应该省略的内容

无关的文件、整个config、secrets/API密钥，以及带有偏见的"我认为可能是X"的理论。给出事实，而不是推测。

## 弱报告 vs 强报告

```text
❌ WEAK: "My login is broken, it throws an error. Why?"
   → no error text, no code, no repro → the AI can only guess

✅ STRONG:
   Error (verbatim):
     TypeError: Cannot read properties of undefined (reading 'id')
       at getUser (auth.js:42)
   Code (auth.js:40-43):
```

```js
function getUser(token) {
  const session = sessions.find(s => s.token === token); // returns undefined if not found
  return session.user.id; // line 42: crashes when session is undefined
}
```

```text
   Expected: return null for an unknown token.
   Actual:   throws TypeError above.
   Repro:    call getUser('expired-token').
   Env:      Node 20, no framework.
```

使用强版本，AI可以直接指向缺失的`undefined`检查并提出一个guard，因为它需要的每个事实都在页面上。

## 为什么这很重要

AI助手**无法访问你的运行系统** — 它仅从你提供的内容进行推理。弱报告迫使它同时猜测error、code和environment，而错误的猜测浪费了一个来回。强报告（确切的trace + 相关代码 + 预期/实际 + 复现 + 版本）将诊断转变为一个聚焦的任务，通常在第一次尝试时就能得到正确的修复。学习编写紧凑的bug报告也使你成为更好的debugger，因为它强制你在提问前隔离事实。