Heya!
You’re probably here because you’re enthusiastic to share some of your resources or knowledge, but hold on! This post will help you share your knowledge in the most efficient and helpful way possible.
Below are some points you should consider before posting. If you don’t meet those requirements, try to refrain from posting to avoid something too basic.
Does my tutorial already exist?
Check the DevForum, DevHub, LuaU docs, Lua docs, and other sites such as stack overflow.
This seems basic, but just do a quick search before you make a post. I find that very often posts are re-made unintentionally.
Below is an example search result when I look for “admin commands”
How do I know if my tutorial is too basic?
Sometimes when we learn new knowledge, we wish to share it as fast as possible. However, sometimes these things are incredibly basic in the grand scheme of things to be presented on their own.
Remember that tutorials on Lua or LuaU basic functionality are considered too basic due to the immense existing documentation online. There’s a lot of people on the internet!
Anything that can be explained in a few sentences should not be posted. Some examples that are similar to what I’ve seen, that should not be posted:
- What “return” does on a module script
- Converting .jpg to .png
- How to place beams and trails
In other words, try to think of tutorials that are multi-step processes to creating a big-picture. A developer would like to know how to make a whole gun system, not just the aim-down sights.
Many of these small solutions are already found through solved solutions in scripting support.
REMEMBER THAT THIS IS AN ACTUAL RULE WHEN POSTING TUTORIALS!
Put effort into your tutorial
Don’t half-ass your way through it. A truly good tutorial doesn’t come without some work to it.
All great tutorials have pictures, code bits, and gifs where applicable.
Here are some example posts that utilize this:
- How to make a clean, appealing UI
- How To Make Your Game More Unique and Interesting | C0BR0T
- A Beginner's Guide to Lua Garbage Collection
- DataStores - Beginners to Advanced
- MeshPart Usage, Performance & Optimizations
- How to make a badge list
Update your post when needed
Anytime you need to fix spelling mistakes, grammar mistakes, or misinformation, fix it. If somebody leaves good feedback, address it and fix what they pointed out.
If people feel as if your post is insufficient, address it and be open to what they are saying.
You will delete some tutorials, it’s the way it goes. Sometimes you hit home with one good one after two or three bad ones when you are new to tutorial-making.
Provide clear instructions and showcase results
Some tutorials lack good instruction and fail to showcase results. Show how to do each step, not what each step is.
Bad example:
Step 1: Get the eggs. Step 2: Scramble and cook the eggs. Step 3: Eat the eggs.
Good example:
For step 1, you will need to grab 3 eggs. Crack these eggs into a bowl of your choice.
(Insert picture of eggs in bowl)
Sometimes, results include data. For example, if you are showing a method that supposedly increases frame-rate, show the data behind it; don’t just say it.
User @SamsAltAcc0unt explains in the replies below the difference between teaching and following steps:
Peer review when possible
If possible, have your post peer-reviewed to make sure your post doesn’t give bad advice, or in the least, have writing errors.
Sometimes having an alternative perspective is more valuable than anything else!
PEER REVIEW IS CRITICAL TO AVOID POSTING ANYTHING THAT IS POORLY MADE OR POTENTIALLY HARMFUL TO DEVELOPERS!
That’s it! If you feel as if I missed something, or could have explained something better, let me know and I’ll fix it.
Thanks for reading, and happy posting!
