Asking questions is an important part in the process of learning something new. While you could spend time figuring out things on your own, it’s better to reach out for help from people who are knowledgeable on the subject rather than attempting to re-invent the wheel. However, it is also important to note that there exists smart questions as well as the opposite. Ideally, you’d want to ask smart questions to get the best responses (or any at all). The essay, “How to Ask Questions The Smart Way” by Eric Steven Raymond gives insight on how to ask smart questions. From my understanding, a smart question fits these general criteria: it contains proper grammar, the problem and the important details relating to it are clearly stated, and the question isn’t convoluted and is rather simple and straight to the point. In this essay, we will be looking at examples that classify a question as such. Below, I’ve provided examples that will help illustrate what exactly a good question is as opposed to a bad question by following the criteria mentioned in Raymond’s essay.
Let’s take a look at what a smart question may look like.
This is the link to the Pycharm Question.
A post on Stack Overflow called, “Pycharm Terminal (Powershell) uses incorrect path for virtual environment even though python interpreter path is correct” specifies the problem at hand. The user mentions in the post that their goal is to use the terminal in Pycharm in order to install new packages and they also show the error that comes up upon trying. They also stated the steps that they took in order to get rid of the error, but unfortunately, had no luck in resolving it. Because of this, I believe this post should be considered a “smart question” because not only would potential helpers know what the user needs assistance with, but they also know what they’ve already tried. In other words, they will receive useful suggestions rather than ones that they already know don’t work.
Here’s, in my opinion, what a poorly constructed question may look like.
Take a look at the HTML Scroll Animation thread.
Another post on Stack Overflow called, “HTML Image scroll animation [closed]” mentions what the issue they’re having is in regards to. They also clearly state what they want to achieve after seeking help, which is to create a smooth scrolling effect when users scroll through their app. However, after stating their goal, they only provide us with this text: “I tried writing javascript that checks the z-value of the image as you scroll and replaces them with a new image as you scroll”. Unfortunately, that is all there is to the post. The problem with this is that we don’t know exactly what they did code-wise and because of that, we can’t pin point the exact thing that’s causing the issue in the first place. This serves as a good example for why it’s important to be clear and concise when asking for help.
To avoid asking “bad questions” on websites such as Stack Overflow, your best bet is to put effort in your post. Double check that what you’re asking makes sense, provide code samples that showcase potential error causing problems, and do anything else you deem to be necessary. Basically, don’t expect someone to put effort into creating a well thought out response if you haven’t done so for your request for help. Expect your energy to be matched.