Meta Stack Exchange is where users like you discuss bugs, features, and support issues that affect the software powering all 153 Stack Exchange communities.

What is meta?
Here's how it works:
  1. Any Stack Exchange user can ask a question
  2. The community provides support, votes on ideas, and reports bugs
  3. Your voice helps shape the way Stack Exchange operates

Is there a particular structure that would be most useful when asking a question? I realise the type of question being asked would obviously affect this in specific cases but, in a general way, when you come to a question, what (level of) details would you like to see in what sort of order? Are section headings useful/distracting? How can a question be asked to make it easiest for people to answer it?

share|improve this question
up vote 12 down vote accepted

I always find a question that's structured thusly is quite a good way to go:

  • Preamble: What is the questioner trying to achieve, what environment are they trying to achieve it in and what isn't working
  • Detail: Source-code (reduced to show the relevant part of the code!), screenshots, exceptions, stack-traces
  • What I've tried: An outline of anything the OP has already tried

Of course this won't always be a good fit and I wouldn't suggest that a question should be broken up this way with section headings as this could make the question seem a bit stilted.

How can a question be asked to make it easiest for people to answer it?

  • By putting time and effort into composing the question
  • Ensuring that the spelling & grammar doesn't detract from the content of the question
  • Providing enough detail so that others stand a chance of answering the question
share|improve this answer

Jon Skeet's Writing the perfect question is an excellent guide to asking questions. There's also a complementary post Answering technical questions helpfully which is well worth a read.

share|improve this answer
    
    
+1 for reference to Jon Skeet's article – JYelton Jun 3 '11 at 19:13

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .