People Answering Questions, Please Read

As part of the Ask a Pro Renewal Project, here are a few guidelines for you gracious people who are taking time to answer questions.

1. Be Polite
A simple reminder to be kind and friendly to the people within the sub-forum, especially the people asking the questions.

2. Don't write complete code for the people asking questions without an explanation
If someone asks a question on "how do to 'x'", don't just spit out a special-tailored function at them and say 'do it like this' without an accompanying explanation of what you've written. This is bad for the person asking the question. Even though you have 'answered' the question, the answer is nothing more than handing them a magical black box that they don't understand. This doesn't help them one bit because they haven't learned anything. Similarly, if someone asks 'could you give me a quick run-down on the xyz API?', give them a quick run-through of the API sprinkled with helpful comments. An example run of the API, coupled with helpful comments, will help them achieve a more complete grasp on the xyz API. If it's possible, break up the code you have written in sections, and explain each section separately. Leave out a few minor details, such as variables, so that the person with the question is forced to read and understand what you've written so that they can proceed to apply it to their own program. But remember, explain your code and what makes it work, otherwise you are just handing them a black box.

3. Be correct and complete in your question answering
If you don't know the answer to the question, don't try to answer it. Incorrect answers only create noise and confuse the people who are asking questions. Also, don't leave the person asking the question hanging by answering with a small 'do x' answer. Supplement your answer with one or more of an explanation of 'x', a code snippet, or a link to a helpful resource for more information.

4. Be clear and understandable
Even if you are being polite, not just handing people black box code, and answering completely and correctly, if the person asking the question can't understand the message you are attempting to get across, then it's all going to go to waste because the person won't be able to use your answer. Don't be vague about anything. Try your best to write an answer with proper capitalization, spelling, and grammar. (Remember, even if it's not perfect, we can tell if you've tried your best to do so!) Enclose any code within tags, as that prevents the forums from doing screwy things with any code you post. Read your post out loud before you post it. Sometimes you'll catch grammatical and flow mistakes that you would not have noticed otherwise.

That's it! Remember to follow these guidelines as best you can so that the person asking the question comes away with as complete of an answer as possible. Happy Answering!

Looks pretty good. The only thing I'm not too certain about is #2. I personally have no issue with people writing full code as long as they comment it well and provide further explanation in their post.

Perhaps the best way to prevent the usual copy/paste errors is by splitting up the code that you write for people - leave a few variables out here and there, separate each section by explanatory text, etc. This is what I do when the answer is a lengthy one, and it forces people to read and comprehend but at the same time is a great way for them to learn.

Modified guideline 2 with some changes described in Bubba's post.

Thanks for taking a look at it, Bubba. Good to know I have some approval :)/>

~Sora

If you give them not-quite-correct code, they'll just copy-paste it and then complain that it doesn't work.

true, immibis, but then the issue is the question. These are suggested guidelines for good answers; people who just want to have code given to them fall under the "valid questions" criteria. Explicitly asking someone to write your code for you is not acceptable, and, I expect, would be either locked or moved to general discussion, possibly merged with the program ideas thread. Assuming the original asker is not looking for that, but actually wants help and is genuinely trying to learn and understand, complete, well-explained code is helpful and a valid way to answer, I think. Answering with advanced code that is quite obviously beyond the reach of the person asking the question is not, even if you make a token effort to explain it.

I see where Immibis is going with this. Personally, I'd try my hardest not to answer a question with code in except in special circumstances. I generally don't feel like answering a question with code is a good idea, for various reasons. However, if I were to answer a question with code, I'd certainly be inclined to do it that way. At that point, I've given them everything they need in order to complete their task. I'd be of the mindset to say 'You have what you need, now go figure it out', in a less rude but still affirmative way. People need to learn to actually use their resources, especially if everything you need is given to you on a silver platter, and all you need to do is 'eat' it. It frustrates me that we need to do this, but nothing much is going to change unless we initiate that change.

Would some moderator mind to sticky this?