Mastering the Art of Asking: A Guide to Crafting Well-Formatted Questions

Play this article

We as developers come across various problems every day and sometimes it becomes a challenge to solve them. We usually google the problem or ask it on the platforms such as Reddit, GitHub, Stack Overflow, and Ethereum Stack Exchange. We might also take help from AI such as ChatGPT, Bard, etc.

In most cases, we get the solution for our problems. But there are very few cases where we are not able to find the solutions or even if we get some results from the internet they are not the solutions to our problems.

There are two reasons for this:

  • In the very least case, no developers in the entire universe have come across the problem you are facing.

  • You are not asking about your problem in a precise and well-structured manner.

Throughout this blog, you will learn how to format your questions in such a way that the fellow developers who are attempting to assist you understand exactly the problem you face.

"There are no bad questions, only poorly formatted questions - Patrick Collins"

4 Steps To Solve Any Coding Problem

Tinker and Experiment

Whenever you face the issue make sure to try experimenting that you think might work. Even then if you can't solve the issue move to the next step.

Check the documentation

I agree sometimes the documentation can be overwhelming but this documentation can be very helpful in finding the exact issue you are facing. In addition, you will also learn how to read the documentation.

Copy the exact error message and paste it on Google. Even if this step does not work then move on to the next step.

Search it on different platforms

There are multiple platforms such as Reddit, GitHub, Stack Overflow, and Ethereum Stack Exchange where you can ask your questions.

If you want to learn in detail what type of questions to ask on different platforms make sure to check out this specific video from Patrick Collins.

But in this blog, we are focusing only on formating the questions

Let us say we are facing some issues while compiling the code and the compiler is throwing some error message.

Do not worry about what the code and error message is, focus on how to format the question

Example of a well-formatted question:

Example of a poorly formatted question:

So make sure to use markdown while posting a question on the internet and make sure your questions are not poorly formatted.

I hope that now you have a clear understanding of how to write a well-formatted question.

Bonus Tip: Make sure to help your fellow developers with the issues they are facing. This will not only help them but also helps you in your development journey ★

Conclusion

Thank you for reading my blog! I hope you found it informative and enjoyable. If you have any doubts or questions, please feel free to leave a comment below. I would be more than happy to help you out.

You can also connect with me on Twitter | LinkedIn | GitHub | Hashnode

Happy Coding!