Asking good questions

How to ask for help

Steps to solving a problem:

  1. Talk to your rubberduck.
  2. ...?
  3. Profit!
../_images/ducky.JPG

Figure 1: Rubber Duck Using Piazza

Sometimes you actually need a response from an animate object. If you actually want a helpful response, it helps to provide the right information.

Things to consider.

  1. Did you search for it first!
    • This is a critical step. Why wait for a response when there is already one?
  2. Where are you posting your question?
    • Is it Piazza? StackOverflow? Email?
  3. Don’t just dump a question onto piazza and expect to have it sovled without effort on your part.
    1. People like helping others who put in effort.

  4. Vague questions get vague answers.

The guideline for posting

  1. Include the approriate details
    1. Title: What is the issue.
      • “It doesn’t work” - isn’t an issue.
    2. If it crashes or errors. Include the entire error!
      • Your test cases
      • The error message
      • What you think the error message means
      • What you think might have caused the error
    3. Explain the question in your own words so others can quickly understand it.
      1. Often, you’ll solve the issue or think of something as you are doing this.
      2. Make sure to mention what you’ve tried.
      3. Screenshots and formatted code make it easier to understand

    4. Make it clear how someone can help you.

    5. If you resolve it makes sure to help others who would have solved it.

http://imgs.xkcd.com/comics/wisdom_of_the_ancients.png

Practice

What looks easier to read?

def square(x):
        return x*x

def sum_of_squares(x, y):
        return square(x) + square(y)

or

def square(x):

return x * x

def sum_of_squares(x, y):

return square(x) + square(y)

Q-67: Is this a good question or a bad question?



../_images/badquestion.png

Figure 2: No repsonse ... I wonder why?

Q-68: Is this a good question or a bad question?



../_images/goodquestion.png

Figure 2: This was responded to?