DEV Community

Assis Zang
Assis Zang

Posted on

9 tips for writing a good tutorial article ✍️

Tutorial articles are one of the best ways to learn something on the internet, but they don't always generate a good experience for readers. Who has never bumped into a Hell Tutorial out there? 😡

With that in mind 💡, I decided to bring 10 tips 💁‍♂️ for you to create better articles and contribute positively to your target audience.✍️👍

1 - Be Objective 🎯

A good tutorial article must have several key elements that emphasize in a specific topic or process. I know you have a lot to teach and not wait to put everything out, but try the maximum to keep the focus on the main subject, when you are something that is outside the scope of the article, you can put a reference as one Link or the dirt of a book if the reader wishes to delve into that subject.

2 - Create a clear and specific title 🧼

The title should be brief and accurately describe what the tutorial is, giving readers a clear idea of the topic or knowledge they will learn.

3 - Create a concise introduction ☝️

It is important that introduction provides an overview of what the tutorial aims to achieve. Explain the importance and relevance of the topic and which will be the goal achieved at the end of the article.

4 - Structure and organize the content 🗂️

Divide the tutorial into sections and subsidies. Always keep a logical sequence by describing the tutorial step by step, it is important that the reader does not need to go back to subtitles, unless it is extremely necessary for the conclusion of the tutorial, in which case you can indicate the reader explaining the reason.

5 - Provide detailed explanations, but be careful with exaggeration 🧭

Always try to explain in a way consists of each stage of the tutorial, but consenting in the main points, in information with relevance to the progress of the tutorial and discarding general information and that do not add to the content approached.

6 - Use visual aids 🖼️

Whenever possible, use relevant visual aids such as diagrams, screenshots or images to support the explanations, you can use websites like Canva to create beautiful designs. Visual aids can clarify complex concepts more simply, but be careful not to overdo it, use them sparingly.

7 - Use practical examples or case studies 🛠️

Whenever you need to explain something complex, consider including illustrations in real-world scenarios. These examples help readers to understand the content taught more easily if they are associated with everyday things. For example, to exemplify asynchronous programming you can use the story of a cook who prepares a meal doing several tasks at the same time, while the synchronous cook does one task after the other is finished.

8 - Provide step by step instructions 🔜

Provide detailed and easy-to-follow instructions, always respecting the sequential order of each one. In texts written with markdown you can use number characters to create lists. For example:

  1. Do it first
  2. Then do this

Break complex processes down into smaller, manageable steps, ensuring readers can follow along and replicate actions.

9 - User feedback and engagement 🙋‍♂️

Encourage readers to provide feedback, ask questions, or share their experiences in the comments section or through other means of contact.
Always take the time to listen to your audience and respond to their questions or suggestions to foster a sense of community and continuous improvement.

Blogs like Dev.to provide a notification system whenever someone comments on your article, so keep an eye out for notifications and encourage engagement, always using respectful and cordial comments.

Conclusion

Remember that a good tutorial article should be accessible, well-structured, and focused on providing a valuable learning experience for readers.
Sharing knowledge is one of the best things that the internet provides for people, but we need to be careful to provide correct and useful information.

Did you remember a tip? Please don't forget to comment!

Top comments (0)