What is meta? ×
Meta Stack Exchange is where users like you discuss bugs, features, and support issues that affect the software powering all 133 Stack Exchange communities.

Should questions be split up into separate sections (Background, Problem, Question, etc), using headers or bold lines? Does it help with readability, or does it make it more of a chore to read the whole thing? I came across this issue while trying to improve my questions after a question ban.

For example, here is a sectioned question while this is unsectioned.

share|improve this question
    
How do you mean "sectioned", exactly? –  Makoto Feb 17 '13 at 2:47
    
I've suggested an edit to your question that might make it a bit clearer. (Like a few of your otherwise good StackOverflow questions, it doesn't get to the point immediately and might be unclear as a result. For example, in the first paragraph it looks like this question is about question bans. –  David Robinson Feb 17 '13 at 3:09
1  
@DavidRobinson I accepted your edit –  xxmbabanexx Feb 17 '13 at 3:11
    
(As an aside: I think the font of the headers (at least on the regular sites) is far too large to use in posts.) –  Arjan Feb 17 '13 at 9:12

3 Answers 3

up vote 4 down vote accepted

When I take the time to do something like that, I put a short version at the top: just the question. Then background and supporting data farther down.

That way readers can determine if they might be interested without a large investment of time or brainpower but all the details are available if they are willing to invest some time in helping me.

This is a writing decision and it should be driven by your audience and by the context in which they will be reading the question. You want to make it easy for potential respondents, because you are asking them to give you something for no return beyond some quite worthless internet points.

share|improve this answer

Here's my thought after reading both your questions: why not ask one section at a time?

My reasoning is that any serious programming effort is going to involve a number of individual challenges, and each one is a step toward completing your goal. Why not track those steps one at a time?

Besides, StackOverflow isn't about getting the community to do a lot of work for you, it's about getting help when you're stuck. A good question on SO will do the following:

  • Offer an interesting challenge to experienced coders
  • Provide a snippet of the code you've already tried
  • Conclude with a clear question mark: the one question you really need answered

To me, one question shouldn't really have multiple sections. If your issue is complex enough that there are multiple interesting, challenging question points, and if there's a significant amount of code you've already contributed toward each section, then you should ask multiple questions instead.

share|improve this answer
    
Certainly one question per question. That is built into the structure of the site. –  dmckee Feb 17 '13 at 3:55
    
I stand behind my answer, but now realize it was to the wrong question. David Robinson's edit made it clear what was being asked. I still feel like the section headings are unnecessary. –  Austin Mullins Feb 17 '13 at 6:48

I wouldn't make it a habit, but visually separating long blocks of text and different sections of code can be helpful. I'm still of the opinion that a question should be to the point, detailed but not overly verbose, and be obvious in what each separation implies.

share|improve this answer

You must log in to answer this question.

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