Skip to main content

Checklist for good questions

The composition of a good question follows a straightforward set of tasks. Use this checklist to make sure your question is complete and easy to follow. This will help your question avoid downvotes and closure. The details for each step are linked in sections that follow.

Step 1: Make an attempt to understand any errors you encounter with your code.

Step 2: Research the problem using documentation and web searches. Make sure you record the resources you used and link them in your question, so the reader of your question knows what you already know.

Step 3: Construct a meaningful title to help readers understand the problem you encountered.

Step 4: Summarize the task you are trying to accomplish at a high level. Help the reader understand why you are writing this code in the first place.

Step 5: Build a complete, minimal reproducible example that lets anyone observe the same behavior using the instructions you provide. Be sure to state clearly what is not working the way you expect. The reader needs to know your expectations because they might not be correct.

Step 6: Format your post so that it’s easy to read. Check for spelling and grammar mistakes.

Step 7: Add tags to your post so that people can find it easily based on their areas of expertise.

Step 8: Be ready to respond to comments right away so that you can add missing information or improve your questions based on the feedback you receive.

Step 9: If you receive an answer that was helpful, upvote it and mark it as accepted.