The Issue
There are many posts on CR that are off-topic for various reasons... Sometimes 10-20 per day! Apparently many users don't read/heed the text on the right side (i.e. "Your question must contain code that is already working correctly, and the relevant code sections must be embedded in the question. Please avoid stripping out key details that may be relevant to the review. If your code is incomplete or not working, you should ask for help on another site."). Perhaps the Ask Question Wizard would help with this issue, but who knows when that will be available?
Meanwhile...
The SE Meta post The new ask page is now live on the network! mentions the following:
The
/questions/ask/advice
page has been replaced by a new modal for first-time askers, and the flow is now broken down into two steps: drafting the question, and reviewing the question — so no more random warnings triggering when you switch from the tag to the title field, while others only show up if you actually try to post. And as the blog post notes, there's also an informational modal at the end, so new askers know what to expect once they've asked their question. Enough words, here's what it looks like... (click on the images to see the larger versions)
Welcome modal for new askers:
and
These can only be edited by staff, so the process to get them live is as described here:
- Create a Meta post on the appropriate Meta site, and discuss it with your community.
- Once a consensus is reached, a mod should escalate it to the CM team. Generally speaking, the "contact us" form is the best way to go, though a ping in chat can sometimes work too (the most that could happen is we ask you to use the form).
- Unless there are any outstanding issues, the CMs should be able to get to it Soon™.
The text in the modal is very coupled to the SO notion of problems (and problematic code) - especially the latter parts:
Before you post, search the site to make sure your question hasn’t been answered
- Summarize the problem
- Provide details and any research
- When appropriate, describe what you’ve tried
On code review the code must be working and the title should describe what the code does instead of a user's goals for review.
My proposal:
replace the text
Before you post, search the site to make sure your question hasn’t been answered
With text like this:
Before you post, please read What topics can I ask about here? and How do I ask a good question?
the guide to postingupdate the ordered list to something like:
- Ensure that you are the author/maintainer of the code
- Ensure the code works to the best of your knowledge
- Make the title describe what the code does instead of CR goals
- Ensure enough context is supplied so reviewers don't need to make assumptions
Update May 26, 2020
I like the suggested list provided by Peilonrayz on May 17th
- Code must produce the desired output
- Code must not error or contain known bugs
- Titles should describe what the code does
- The more code you provide the more we can help
Update September 02, 2020
We have been notified we can't change the desired text or list items. And upon discussion we've decided on the following:
You’re ready to ask your first question and the community is here to help! To get you the best answers, we’ve provided some guidance:
Please read What topics can I ask about here? and How do I ask a good question?
- Code must produce the desired output
- Code must not error or contain known bugs
- Titles should describe what the code does
- The more code you provide the more we can help
Before you post, search the site to make sure your question hasn't been answered.
- Summarize the problem
- Provide details and any research
- When appropriate, describe what you've tried
You'll find more tips in the sidebar.
Which will look like:
Update September 16, 2020
There is a slight change of wording from the previous decision -specifically list items 1, 2 and 3:
You’re ready to ask your first question and the community is here to help! To get you the best answers, we’ve provided some guidance:
Please read What topics can I ask about here? and How do I ask a good question?
- The code must produce the desired output
- The code must not error or contain known bugs
- The title should describe what the code does
- The more code you provide the more we can help
Before you post, search the site to make sure your question hasn't been answered.
- Summarize the problem
- Provide details and any research
- When appropriate, describe what you've tried
You'll find more tips in the sidebar.
Update October 9, 2020
The modal has been updated! 🎉 🎉 🎉