Forum Moderators: not2easy
I hope you all are fine and in good health.
I have started to build a tutorial (email, internet, softwares, hardwares, networking, Html etc) site in urdu (language). Can you please guide me how to write a good tutorial?
In the first paragraph tell them exactly what the tutorial will provide. For example,
This tutorial will provide you with a step-by-step guide for using WS_FTP. At the end of this tutorial you will know how to upload files, change permissions using CHMOD, create and delete directories and whether to upload files in ASCII or Binary.
One of the most important aspects to remember is not to crowd your tutorial with all the information you have on the subject. Create numbered steps that provide a concise description of the action they need to take and what the results of that action will be. Use links wisely, link to the detailed technical info while keeping the tutorial free from unnecessary details.
1. Use short sentences.
2. Don't reference items mentioned in a previous step.
3. Use repetition to reinforce the main ideas.
4. Use jargon sparingly.
5. Make use of bold text for important items and headings.
<added>If you're not familiar with writing tutorials, do a search for some and emulate the style of the tutorials you find most effective. Take note of the ones you find cumbersome to use and avoid using similar techniques.</added>
[edited by: digitalghost at 3:22 pm (utc) on May 9, 2003]
Like, for example, the "options" or "preferences" section on a program. Some can be very very cluttered with checkboxes, tabs, advanced sub-boxes, etc.
A couple of screenshots with some snippets of text can save paragraphs of details.
You don't have to do full-blown screenshots, just crop the parts that are needed.
In other words, you'll need to be more specific and detailed when writing for absolute beginners than you will when writing for advanced readers/users/programmers.
When writing for beginners, make no assumptions on what they know. Always assume they know absolutely and let the rest of the tutorial flow from there.
For truly advanced tutorials, the opposite should be true, but don't get too carried away with your assumptions on what they know or you'll lose your audience.
