I have seen some technical articles with really good content, but bad structure.

No matter how good the content is, bad structure puts people off from reading your articles!

So, here are 6 tips you can use to improve your articles straightaway! ๐Ÿ‘‡

1/ Split your articles into sections

Don't write everything in one section because it makes it difficult to read. Moreover, it also confuses the reader.

See the two pictures - which article is easier to read and less confusing?
2/ The layout is important

A proper layout makes an article easier and more enjoyable to read

Make use of:
- whitespace
- bullet points
- headings
- sub-headings
- images

Once again, compare the two articles without headings and bullet points.
3/ Write for clarity

Avoid using fancy words and terminology, if not needed.

If you can simplify your article, do so. Your job is not to sound smart, but to be as clear as possible.
4/ Split your text into paragraphs

Sometimes, I see articles that have 1 or 2 enormous paragraphs.

It's incredibly tiring and difficult to read such articles.

Compare the two images - isn't it harder to read the article with those walls of text?
5/ Code screenshots

Code screenshots are bad for accessibility. If you do not add alt text, you exclude visually impaired people.

Secondly, it's annoying for people who want to quickly try out a code snippet.

If you really want to use screenshots, try to add snippets as well.
6/ Short sentences and paragraphs

Split long sentences and walls of text into multiple:
- sentences
- paragraphs

Big walls of text put the readers off. It's tiring to read such articles!

Compare the two images and see which one is easier to digest!
That's it for now!

Any like/retweet/reply helps! ๐Ÿ™

Alternatively, you can subscribe to the technical writing newsletter

https://t.co/y8zA94c7Pr

You May Also Like

๐ŸŒฟ๐‘ป๐’‰๐’† ๐’”๐’•๐’๐’“๐’š ๐’๐’‡ ๐’‚ ๐‘บ๐’•๐’‚๐’“ : ๐‘ซ๐’‰๐’“๐’–๐’—๐’‚ & ๐‘ฝ๐’Š๐’”๐’‰๐’๐’–

Once upon a time there was a Raja named Uttฤnapฤda born of Svayambhuva Manu,1st man on earth.He had 2 beautiful wives - Suniti & Suruchi & two sons were born of them Dhruva & Uttama respectively.
#talesofkrishna https://t.co/E85MTPkF9W


Now Suniti was the daughter of a tribal chief while Suruchi was the daughter of a rich king. Hence Suruchi was always favored the most by Raja while Suniti was ignored. But while Suniti was gentle & kind hearted by nature Suruchi was venomous inside.
#KrishnaLeela


The story is of a time when ideally the eldest son of the king becomes the heir to the throne. Hence the sinhasan of the Raja belonged to Dhruva.This is why Suruchi who was the 2nd wife nourished poison in her heart for Dhruva as she knew her son will never get the throne.


One day when Dhruva was just 5 years old he went on to sit on his father's lap. Suruchi, the jealous queen, got enraged and shoved him away from Raja as she never wanted Raja to shower Dhruva with his fatherly affection.


Dhruva protested questioning his step mother "why can't i sit on my own father's lap?" A furious Suruchi berated him saying "only God can allow him that privilege. Go ask him"