freeCodeCamp.org
·
如何提出一个优秀的（技术）问题：调试代码求助的艺术
💡
原文英文，约1400词，阅读约需5分钟。
📝
内容提要
计算机执行指令，但用户常常表达不清，导致错误。提问时应包含代码、错误信息及详细描述，包括重现步骤、预期结果和实际结果。提供充分上下文能提高获得帮助的机会，避免假设以便他人理解问题。
🎯
关键要点
- 计算机会100%按照用户的指令执行，但用户常常表达不清，导致错误。
- 用户需要将自己的期望与代码行为对齐，以解决bug。
- 假设会阻碍他人理解问题，导致无法获得帮助。
- 提问时应包含三个关键要素：问题代码、错误信息和详细描述。
- 提供充分的上下文信息可以提高获得帮助的机会。
- 在大型项目中，分享GitHub仓库或创建最小重现代码是有效的求助方式。
- 对于单文件项目，可以直接在聊天中分享代码或使用CodePen等工具。
- 在提问时，务必包含完整的错误信息，以便他人理解问题。
- 描述问题时，应详细说明重现步骤、预期结果和实际结果。
- 尽管提问过程可能繁琐，但收集信息后可能会自己解决问题。
❓
延伸问答
如何有效地提问以获得技术帮助？
有效提问应包含问题代码、错误信息和详细描述，包括重现步骤、预期结果和实际结果。
在提问时，为什么要避免假设？
假设会阻碍他人理解问题，导致无法获得有效帮助。
如何分享大型项目的代码以获得帮助？
可以分享GitHub仓库或创建最小重现代码，以便他人更容易理解和解决问题。
提问时需要包含哪些错误信息？
应完整复制和粘贴控制台或终端中的错误信息，以便他人理解问题。
在提问时，如何描述问题的实际结果和预期结果？
应清晰说明预期结果和实际结果，必要时可以附上截图或视频。
提问过程繁琐吗？
虽然提问过程可能繁琐，但收集信息后可能会自己解决问题，减少后续沟通的时间。
➡️
