This is a list of “guidelines” on how to write a proper tutorial. Comments are more then welcome on this subject as I think too many people think tutorials are just command steps lined up saying this will work, it worked for me. Too few tutorial writers take the time to lay out their guides properly and select a target audience. You can always write a list of commands but can you make the reader WANT to read it? Photoshop tutorials for example are generally very visual but SELDOM do I see a tutorial that actually explains the settings that are in the different windows. It’s always “in order to make THIS image…” never “in order to make an image LIKE this one…”

I enjoy writing both expert and beginners tutorials and I hope some future writers start following some for these points as they really do work for most of the people.

1. Know who you are targetting. A beginners tutorial needs a lot of explanations, an experts not so much. Classify yours properly and always use the lowest common denominator of your target group.
2. Write in a way that interacts with the reader, not from your point of view -> from THEIRS
3. Use screen-shots when needed but find the fine line. Use them whenever there is a dramatic change in the visuals by the action described, not always when it purely says “the next screen has one button : OK”
4. Use descriptive language and let the reader know what to expect. Do not lure them into a false sense of security by saying: ” this is very easy and you should be up and programming your own Operating System in no time”.
5. Once started, follow through out the tutorial one writing style. If you have multiple authors, make sure they all write the same style more or less.
6. Make it fun to read. monotone and scientific is not bad, but it’s not for tutorials, it’s for white papers and publications.
7. Open questions in your writing style, challenge the readers brains but keep the questions at a small level, don’t make them think they need a science degree. Things like:” …as you know , by opening the web protocols to public we open ourselves to probes and attacks…” doesn’t reveal what kind of probes or attacks but makes the reader think as you stated AS YOU KNOW… the readers brain starts working because THEY SHOULD KNOW
8. Keep the tutorial visually pleasing. This does not mean to use funky colors etc. but use images, photos or drawings frequently so that you do not end up with overly long text blobs that strain the eye and make you exert yourself by concentrating.
9. If you write something platform specific, STAY on the platform but add comments and notes regarding the same thing on other platforms. This  give the reader confidence that you have done this more then just once and know what you are doing.
10. Learning is supposed to be fun and a tutorial is a way of learning. Keep it fun, keep the reader reading and WANTING to read. If you can put a smile on the readers face with a tutorial and convey the knowledge you wanted, chances are he or she will DEFINITELY remember your tutorial and word of mouth travels…

Tutorials are guides and guides are essential to someone’s learning in a given subject. If you can make things as easy on the reader as possible you will be highly successful and your reader base will return to you for advice and guidance. If you have more ideas, please let me know…

Popularity: unranked [?]