如何提问
澄清
首先你需要明白的是:
我们没有义务回答你的任何问题。
任何人的精力都是有限的。除非你雇佣我们,作为全职的顾问。否则,这都是义务的劳动
我们当然乐意帮助新手渡过难关,但很多情况下,新手很难做到一些事情
最基本的是要做到互相尊重
我们明白你遇到问题后焦急的心情,但就如上面所说,我们也不希望将有限的精力浪费在无意义的问题上
我们当然愿意回答你的疑问,这将帮助我们发现和解决问题,帮助项目进一步发展
提问之前
在真正向我们提出问题之前,请先尝试自行解决。
本文档几乎所有的教程页面都是step by step
的教程,请不要跳步骤
不得不承认,由于技术原因,本文档的页面在更新后会有一段时间的延迟,更改才会同步到网页上,请尝试清除浏览器缓存或者等待一段时间,参考这个issue
请确保你的命令等拼写正确,有些命令需要做出一些更改,比如环境名称,文件路径等
一般来说,项目都会有相应的自述文件README.md
,请先阅读上面的说明
如果确实按照文档上的方法出现了错误,请先查看仓库的Issue界面有没有人提出过一样的问题,或将错误代码在搜索引擎上查找一下,一般来说,很多问题都是有现成的解决方案的
需要注意的是,在网上查找的解决方案,需要注意软件版本和文章发表日期等信息,时间越久,参考价值就会相应的贬值,本文档也不例外
提问的方法
提问的渠道
如果是本文档相关的问题请在Issue界面提交Issue,非必要请不要在聊天软件上直接沟通
如果是其他问题,请通过电子邮件或聊天软件获得帮助,一般来说会在24小时内获得回复,如果没有回复,请自行反思是否已经有相同的问题,或者问题过于简单了,再重新发送问题(不排除我们忘记回复的可能性)
将你的问题描述出来
用简短的语句描述你遇到的问题,描述你的系统环境和软件版本等信息
描述你已经尝试过的解决方案或者提供链接
简单描述你想要的结果和你期望的结果
比如
问题描述:我按照本文档提供的教程无法正常运行示例代码(仓库链接),我已经查阅过搜索引擎(链接),我已经尝试过使用dev分支,没有解决问题
操作系统:Archlinux
软件版本:conda 22.9.0
Python 3.9.13
Pycharm 2022.2 community
opencv-python 4.5.5.64
opencv-contrib-python 4.5.5.64
期望的结果:成功运行示例代码,显示小飞机图标
现在的情况:未能成功运行代码,终端提示错误xxxxxxx
附上你的错误信息和复现错误的方法
如果代码比较短,请直接在问题中附上源代码,如果代码过长,或者是Python这种严格要求缩进的语言,请使用网络剪切板发送代码
或请写一个简单的程序复现这个问题
如果是软件的问题,请通过截图win徽标键+Shift+S
组合键或录屏的方式提供复现问题的步骤
截图尽量全面,请提供尽可能多的信息,很多情况下是类似右下角环境的设置问题
如果是无法截图的问题,请通过录像软件录屏或者使用手机拍摄,注意要确保能正确辨识出问题,不能太模糊,同时注意保护隐私
如果是报错信息,请附上文本形式的错误信息,并且告知你在搜索引擎上搜索到的相关问题的链接,帮助我们复现和排查问题
无效提问
当你被问到一个问题,没有问题的描述,没有预期的目标,没有报错信息,你会怎么解决?
当别人给你一段代码的时候,你是喜欢接收一张手机拍摄的不清楚的照片还是直接可以复制的代码片段呢?
所以在提问之前,请至少要做到互相尊重
推荐阅读
更多请看这篇文章 提问的智慧 希望您能有所收获