How to Effectively Write a Tutorial

A lot of tutorials have one goal (not necessarily a bad thing) and only one way to get there (a bad thing), often saying things like, "This is what we want to do." But what if it isn't what I want to do? There's rarely ever only one way to do something. Personally, there have been many times when I've had a certain idea in mind, and found several tutorials on the subject, but found them to be oddly specific, never touching on the thing I needed. I know there's a point where telling people everything would only serve to confuse them, but at least give them options. If you don't want to discuss the other options you give, at least point people elsewhere.

If all you do is say things like, "do this," "push this button," or "type this setting here," you're only doing a disservice to a large percentage of your readers, leaving them with no more knowledge than they had before. The important thing to tell them is "why." If applicable, also mention what not to do, and why. This goes together with giving people options.

Regardless of how you present the steps in your tutorial, tell people that, not only is it okay to play around with things, but that they should if they really want to learn something.

I know this may seem obvious, but make your title specific. If, for example, you wrote a tutorial for a certain piece of software, mention it in the title. I've actually seen people forget this. As a side note, also clearly state which version of the software you're using, as the terminology may have changed from previous versions.

Don't assume your readers level of knowledge unless you clearly state the level of knowledge that they need. If you write a tutorial that's a little more advanced, don't be afraid to link people to beginner tutorials, or at least basic guides on the usage of your particular piece of equipment or software.

Give examples. Use pictures and/or video. If you're making a writing tutorial, give writing samples. I know I've neglected this myself, but this tutorial is very general.

With all this in mind, experiment, find what works for you, but at least take what I've said to heart.

For the other side of the coin, see HOW TO USE A TUTORIAL