Tutorial - How to create a PROPER tutorial.

Discussion in 'Resources' started by DrAgonmoray, Feb 23, 2012.

Thread Status:
Not open for further replies.
  1. Offline

    DrAgonmoray

    I've noticed many so-called "tutorials" in this section that really lack quality. With this tutorial, I'm hoping people will learn how to create better tutorials.
    At the end of this tutorial, you should know how to make a decent turorial.

    Step 0: (pre-planning)
    Do your research. I can't stress this enough. While it may seem like a good idea for you to learn by making a tutorial, this is the fact: it's not. Not only will you make a fool out of yourself, you will also spread bad information and cause aspiring developers to unknowingly do something badly.

    Step 1:
    Think about what you're going to say, and try it yourself. Nobody likes a rushed tutorial, or one that doesn't even work!

    Step 2:
    CLEARLY state your goal of the tutorial. Tell what should be accomplished after reading.
    Step 3:
    Write your tutorial, separating it in easy-to-see paragraphs. Provide many examples and make sure to elaborate. Try not to stray far from the topic at hand, as this causes confusion.

    Step 3.5:
    Pictures and demos allow for easier (and better) understanding. Obviously every tutorial might not need these things (such as this one) but overall, visual aids help the reader a lot.

    Step 4:
    Revise your post. Read your paragraphs backwards, looking for grammar, spelling, and other mistakes. This is the time to refine your tutorial, making sure everything flows and makes sense.

    Step 5:
    Publish your post. If users reply with criticism (even if they are hostile) take it into account, and use it to make your tutorial better. If somebody doesn't like the way you explained something, look at it and see how you can make it better.

    --

    DOs and DON'Ts.
    DO:
    • Provide many pictures and examples
    • Elaborate on the topic at hand.
    • Edit and revise your post.
    • Make the tutorial as clear as you can.
    DON'T:
    • Stray or elaborate on things off-topic. (even if it's just a little off)
    • Rush the creation. Think about it for a while.
    • Write about something you know nothing about.
    I hope this helps as some general guidelines for writing tutorials.
     
  2. Offline

    DrBowe

    Yo dawg, we heard you like tutorials!
     
    caelum19 likes this.
  3. Offline

    caelum19

    Where did you learn to make this tutorial tutorial? a tutorial tutorial tutorial? if so link please

    haha so unoriginal caelum, great tutorial tutorial :D
     
Thread Status:
Not open for further replies.

Share This Page