Transparent means the reader doesn’t even notice it. In the introduction, you can make jokes and express a bit of your personality, but when you get to the process you should adopt a totally straightforward, transparent writing style. It’s always important to write clearly - but it’s absolutely crucial that a walk-through is written as clearly and simply as possible. In this piece, I’m going to list the ingredients that go into a well-designed programming tutorial. Ideally, the learning objective is clearly stated, right in the title. The style, structure, and scope of the piece should be designed to fit a learning objective. In fact, basic subjects have a larger potential audience - there are always more beginners than advanced practitioners in any field.īut … to be successful you do need to know how to write an effective tutorial.

Say you’re working with a newly released version of a highly popular tool or framework and you learn how to do something tricky that’s not yet well documented - you have valuable knowledge to share.Įven if you’re just starting out on your programming journey, you could create something useful for other learners. If you’ve mastered something in programming - a process, a task, a method - you can probably write a tutorial about it that other people will find useful. We publish a lot of tutorials at Better Programming.

How to make a computer program tutorial