SRL Archive - Outdated Tutorials

This is my tutorial on writing a Tutorial. It will show you exactly what the title says. That's how a tutorial should be.

Writing a Tutorial

Tips on Writing Tutorials:

• Write a tutorial someone will want to read
• Don't bunch up text in paragraphs too big. Make it easy to read. I general click away from tuts that are bunched up, and prefer ones with lists.
• If its a scripting tutorial, use comments to explain some stuff in the code also. Some people learn better that way
• Use Pictures - Visually are very nice
• Do not assume that the reader knows how to do the stuff that makes up your tutorial. Link if needed.
• Use good formatting - Need I say more.
• Use Proper Grammar and Spelling.
• If it's something big, add a FAQ section and add to it as people post questions.
• You should have: The Cover Page, a Table Of Contents, a preface, and FAQ if needed.
• Copyright your tutorial (copyright 2009 NeehoSoft.com)
• Add Detail! The more the better.

• Organization: It is well structured with a comprehensive table of contents, FAQ and detail.
• Content: The material focuses on user tasks, provides clear instructions and is concise.
• Appearance: It has a nice format, and is not cluttered.
• Language: The text is easy to read and aimed specifically at the users.

~NeehoSoft

*Don't bunch up text in paragraphs too big. Make it easy to read.

Perhaps spread yours out a bit? It's hurting my eyes trying to read it.

use:

[noparse]

• item one
• item two

[/noparse]

• item one
• item two

Makes it a bit nicer :)

Use different fonts for headings etc, use different colors, bold words, underline etc.

This tutorial needs work.

I don't think it's that bad, you have a lot of good tips in there that a lot of people should use. I would suggest making your formatting more spaced out and use lists like MasterKill said.

I think it would be best to have this particular tutorial in awesome formatting. I think you should also use you own points such as picture examples and examples of what makes the guide easy to read.

You can expand on every point and make it really clear to anyone who wants to write a tutorial. Just looking at the point you have, you can easily make it long enough for a table of contents plus a separate heading for different sections. I think this is a pretty good idea, but you can and should make it a lot better! :)

Thanks,

Coh3n

OK, a few tips here.

• Space it out a bit more
• Make a list like this one, already mentioned above on how
• The text "What makes a good Tutorial in General?" isn't in a good spot. In fact I missed it the first time reading through. I suggest moving it to the left side, making it a bit bigger, and maybe even change the color
• The "Tips on Writing Tutorials:" text should be the same format as the "What makes a good Tutorial in General?" text, as they are both sub-headers(I think that's the correct terminology :p)
• Give your text more 'pizazz'. Make it a different(but readable)font, and maybe even change the color to something like a navy blue, or a dark green (darker colors so it is easy to read)
• EXAMPLES!
• Move your title to the top, and make a separate section called "Introduction", for organization purposes. Also make the introduction a bit longer
• Design a picture for your tutorial to catch the eye!

(Added this so you wouldn't think I was a hypocrite :hypocrite:)Now i know you have read my tutorials and i know your saying something like "Why don't you have some of these things?". Well I'll let you in on a secret(not really a secret :p). I am currently making a huge tutorial for that tutorial contest, with a lot of detail, and incorporating all of the things i posted above. I've wanted to do this for a while, but was to lazy to do it, this contest just got me motivated to do it :D.

Over all, it is a good tutorial with lots of good points. Personally, i think this was needed. It still needs a bit of work, but I'm sure you can make it really good. I am impressed with your willingness to help out around the SRL community, you seem to be very active. Good job, and keep up the good work!

~Bionicle

Oh the irony!