主题颜色
最小可复现问题报告
最小可复现问题报告是一组紧凑证据,使他人能看到同一故障、理解预期,并识别下一步调查位置。
组成部分
| 组成部分 | 目的 |
|---|---|
| 环境 | 明确操作系统、版本、依赖、硬件或发行版细节。 |
| 预期与实际行为 | 展示需要解释的差异。 |
| 按时间排列的步骤 | 保留故障前的因果顺序。 |
| 诊断尝试 | 说明已经测试或排除了什么。 |
| 小型复现 | 移除无关代码或数据,同时保留故障。 |
| 原始证据 | 用可读的标准格式提供日志或记录。 |
该模式直接服务于 AI 编程工程循环,因为相比“它不能用”这样的宽泛描述,智能体也更善于从小型可复现故障中推理。
在本地 AI 编程调试中,原始证据应注明故障出现在哪里:浏览器 Console、服务器终端,还是环境与启动日志。还应说明触发动作或最近代码改动;许多调试会失败,正是因为智能体只看到错误,却看不到导致错误的因果上下文。
症状先于理论
报告应先描述症状,再写猜测。可以提出假设,但必须标记为假设并附证据,防止帮助者调试提问者的理论,而非真实系统。
目标先于路径
当问题涉及如何完成某事时,应先说明真实目标,再说明尝试的方法。既有路径可能错误;明确目标后,回答者可以建议更好的路线,而不只是修补一个坏计划。