Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.69 KB

howto_ask_a_good_stackoverflow_question.md

File metadata and controls

35 lines (25 loc) · 1.69 KB

How to ask a good question on Stackoverflow? ⭐

The golden rule of asking any question is to connect with your audience and explain your question with examples, whenever possible.

The questions you ask, unless your audience grasps your question clearly, they would either wait for more information or they will simply choose to skip answering your question.

I have seen often many new users of stackoverflow asking questions that from the following pitfalls:

  • NOT properly formatted
    • should learn how to use markdown to write properly formatted questions/answers.
  • NOT properly presented
    • should try to rephrase the question by breaking it down in coherent sections, if necessary.
    • examples are always helpful
    • plots/diagrams could speak volumes (if used where applicable)
  • WITHOUT adequate information
  • DOES NOT mention:
    • what they have now (current state)
    • what they want from the solution (future state)
    • what they have done (current progress)

      this could be an explanation of the strategy/code they have tried so far.

This should help new stackoverflow users on to self-educate themselves:

How to write a good question on Stackoverflow? 🔥 🔥 🔥

Always provide a complete minimal reproducible example with code, data, errors, current output, and expected output, as formatted text. If relevant, only plot images are okay. Please see How to ask a good question


A must read: How do I ask a good question? 🔥