In this article, I'll share with you five common mistakes to avoid when writing technical articles and how to organize your technical articles afterward. As a newbie technical writer, you should try as much as possible to avoid mistakes and write good articles for your readers.

Mistakes to Avoid and what to do instead

1. Don't reintroduce yourself
2. Don't leave the table of contents unorganized
3. Don't just divide the article into sections
4. Don't forget to add syntax highlight to the code snippets
5. Don't end your article with the last section or step without a conclusion section

• Don't reintroduce yourself

You don't need to reintroduce yourself to the readers in an article. An example of what you should avoid in an intro is this intro in the picture below:

You don't need this kind of intro in an article, that's why you have a profile. Instead, your intro should be able to tell the readers what problem you're trying to solve for them or what the article entails in summary.

• Don't leave the table of contents unorganized

Try to implement a table of content and make it clickable if the platform you're writing your technical article has the table of content feature. If they don't, you can break your articles into sub-headings with h2 texts and use that to create a table of content.

• Don't just divide the article into sections

When you break the articles into sections with step one, step two, etc. You should be more explicit about what those sections do. For example, First Step: How to Install React on a Windows Computer. Avoid using (text in markdown) to represent the sections of the article. You should use h2 texts instead.

• Don't forget to add syntax highlight to the code snippets

Make sure your code snippets have syntax highlighting. You can do this in markdown, see an example of Javascript.

js
//code

• Don't end your article with the last section or step without a conclusion section

Your "Conclusion", "Final Thoughts", or "Wrapping Up" sections come last. In this section, you should appreciate your readers for taking the time to read your article, write your final thought about the article or write something that shows you are wrapping up the article.

Even though mistakes are inevitable as a newbie, I hope this article helps you dodge these common mistakes in your next article and thanks for reading this article!.