While browsing questions of new users at Stack Overflow I noticed that many questions get less attention and low rating due to being weakly formed. In this post I want to highliget some of the common problems and show how to make your questions better.
Read the official guide
If you are posting first time the ”how to ask” is must read. Not doing so means no respect to community and you will probably get appropriate response. The rest of this post are additions to official “how to ask”.
Learn from good questions
Look at high rated questions and try to understand how they are formed. Try to use similar logical structure, language and style for your posts. Improve quality of questions incrementally, by looking at other posts and taking into account feedback for every new post.
Change the names to Foo Bar
Domain specific names usually distract from the main problem. Also your names may be long which is also distraction. Try to rename variable and function names to some gerneric names. Foo and Bar are just examples, you can come up with other generic names.
Format the text
Use the text formating capabilities of the system. It’s important to format the code sections, highlight keywords in the text, use quotes and lists. Learn the Markdown sytax and make formating a habbit. Again look at the other posts for style examples.
Show your interest
When posting a question about your problem you may want also to tell what you have tried so far that didn’t work. This shows that you are really interested in the problem and it’s not a homework type question, though nothing’s wrong with it.
Be short and specific
Drop redundant data that is not related to the question. Redundant information is another type of distraction. Generally your post should not contain any information that is not helping to understand the problem.
Keep it up to date
When you start to get answers to your question you may need to make corrections and clarifications in your post. Also even if the responses don’t answer your question completely but make some clarification you may want to edit your question and add additional information to help others to understand it better.
I wrote this having Stack Overflow in mind. But the advices are general enough to be useful in general.