I get the idea of simplifying the language for non-English speakers. That’s a really good point.
You omitted a question which is very important. “What have you already tried?”
Other than that it looks pretty good for a shortened version.
However, I think these should be verbose, because we want to point to the post, and we don’t want to have to elaborate on the post. Where do the longer explanations of why go?
I think all the highlighting reads a bit like a clickbait article, but maybe that’s a good way to grab attention? I always bold class names, buttons or menu items the person should click in instructions. In the post above, I also used bold for sub-headers. What were your thoughts on the what you highlighted?
@phoenixdk and @ximossi I also want to say this without being offensive - just as a point to consider as we discuss this. It’s clear you both have experience from other forums you’re drawing from and I respect and appreciate that experience. Between the two of you, you have a total of 10 accepted solutions on this forum. From that, I am infer that you have not seen and answered nearly as many people as I have. When I made the edits I did, it was coming from the experience of answering hundreds of posts - many times more than I have accepted answers.
I think it behooves us to find a balance between simplification, and thoroughness. I specifically made bullet points to create a checklist for people to follow. So while they’re verbose, the bold parts are the only thing someone needs to pay attention to to get it.
Maybe something like this would be a good compromise? (Keeping in mind I didn’t simplify the language yet.)
How to write a good question
Write a Good Topic Description
Give the topic a descriptive title that captures the problem accurately - it’s the first thing people will see of your help topic. “Problem with CharacterBody2D” is a bad title, “CharacterBody2D doesn’t trigger collision during move_and_slide()” is better.
Use The Template
Use the help topic template - fill in the Godot version you’re using and any plugin versions as well.
Format Your Code
Post any code that is relevant. Resist the urge to only give the code you think is relative, and post the full script causing the problem. Please format your code correctly. Failing to do so will likely result in your first reply being a request to format your code. Do not post screenshots of code. These are hard to read on some devices, and also make it harder to get a good response. When your code is text and formatted correctly, they will often correct your code for you.
There are three ways to format code:
- Wrap it in 3 backticks (```) above and below the code to create a
code block. Adding “gd” after the top set will format your code as GDScript and make it even easier to read.
- Press the Preformatted Text button (
) in the toolbar. This is the best option for people on Mobile devices, and people using non-English keyboards. Note you can still add “gd” at the end of top three backticks to make your code even easier to read.
- Press Ctrl + E on your keyboard. This is the keyboard shortcut for option #2.
This:
#Paste your code here
Turns into this:
#Paste your code here
Describe Your Problem
Explain the problem you’re having in detail, using the 7 questions below. (Keep in mind that while a picture is worth a thousand words - that isn’t true if it’s a picture of text. Be sure to copy, paste, and format any text.)
What problem are you having?
Tell us the problem you are trying to solve. Often people post the problem with the solution to the actual problem they’re having. In Godot, there are often simple solutions to complex problems. This is especially true if you are a programmer coming from another language, or you are getting advice from an LLM. This is known as the X-Y Problem.
What did you expect to happen?
It may not be obvious to your readers what you think should happen. Tell us. also, do not assume that your reader has played the same games as you. Also don’t expect anyone to watch a 30 minute tutorial video to see where you went wrong.
How / when did the problem arise?
Was this working before? On an earlier version of Godot? Or before you made a change? Did you update your video drivers recently or make other changes to your computer?
What steps have you taken to try and fix the problem?
If you don’t want to get suggestions for a bunch of things you’ve already tried, tell us what you’ve done to try to fix the problem. Showing that you have spent time trying to solve the problem is more likely to get you more thoughtful responses in return.
What error messages have you gotten?
You can copy messages from the editor directly and paste them into your post. That gives us information to help you - even if it seems unimportant or nonsense to you. Do not use screenshots. They are harder to read, and if we may need to copy and paste them to do our own research.
What does your Editor look like?
Add screenshots of your Scene Tree, Inspector and/or the whole Editor if you think it might be relevant. If you are new to the forum, you can make replies to your own post to add additional screenshots after the first. Do not try and recreate your Scene Tree in text. There are things we can see by the icon or color of an icon, warnings and other things that you may not notice but can help us solve your problem.
How does your post look?
Before posting, re-read your question to make sure it’s clear and presentable - then hit Create Topic, lean back, and wait for help to arrive. If you later notice something that can be improved, you can edit your topic.
Thoughts?