Extra 1 - Asking General-Scripting Questions
If youâre creating a topic asking for a general question about scripting that you donât understand or of how to script a certain thing, all you need to do is describe what you donât understand or what you want to know. Provide code examples for better clarity if necessary.
Extra 2 - Attempting to help another scripter
Not everyone will follow the steps above the create a problem. That being said, the developer still needs help regardless of the topic structure. If you want to help a fellow scripter with their problem, here are some tips:
Properly encouraging them to include relevant information
If they did not include relevant information that is crucial to solving the problem they are having, you should tell the user to provide said information in a positive tone. Phrasing things in a positive tone will give the developer seeking help a sense of comfortable and reassurance.
Bad:
Why didnât you provide the code? We need the code to help you solve the problem. Always provide the code.
Good:
Hey mate, can you please provide the code where the problem is occurring?
Otherwise, it will be very difficult to help you solve the problem you are having.
Donât criticize parts of their script that are unrelated/donât affect the problem
The developer is seeking help for the problem they have. They are not asking for others to criticize the way they script. They are asking for others to help solve the problem they are having. So help them solve the problem they are having by guiding them instead of criticizing their code.
That being said, you could recommend some ways they can improve their code by pointing out some bad practices after they have found the solution to their problem. If you do decide to do this, ensure that you describe why you think this part of the code should be change
Guide them towards the answer
I know its tempting to just provide the answer right away instead of taking the time to guide the developer towards the solution because it could save lots of time. However, the developer wonât learn from the problem if the answer is provided towards them. When guiding them towards the answer, try leading them through the steps to the solution. When providing them with code, add comments so the developer will understand the code and learn from it.
Have Patience
Not everyone is as skilled as you are. Itâs best that you do your best to help guide them through the problem. If they donât understand a concept, try your best to explain it to them so they will get a better understanding of the problem and how to find the solution.
Avoid telling the person seeking support to figure it out by themselves
Even if the solution is obvious to you, it might not be obvious to them. Instead of telling them to figure it out on there own, give them the benefit of doubt and guide them towards the solution.
Same goes for if the developer did not try to troubleshoot on their own first. You should still help them, but also include that they should next time try to troubleshoot on their own while also giving tips on how to debug and such.
Linking the documentation
When thereâs a concept thatâs crucial to solving the problem that is explained in the Creator Documentation, try linking the specific documentation article any other relevant documentation links when guiding them towards the answer.
For example, if youâre trying to explain RemoteEvents to another developer, give them a brief run-down of RemoteEvents and then provide a link to the Documentation article on RemoteEvents so the developer can get a detailed explanation on how they work.
Another example would be if the solution to the problem is using a specific method, such as MarketplaceService:PromptGamePassPurchase
You would give a brief rundown on how the method works, as well as how it relates/solves the problem and provide a link to the method on the documentation.
