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?
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! 👇
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?
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.
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.
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?
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.
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!
Any like/retweet/reply helps! 🙏
Alternatively, you can subscribe to the technical writing newsletter
https://t.co/y8zA94c7Pr
You May Also Like
I'm going to do two history threads on Ethiopia, one on its ancient history, one on its modern story (1800 to today). 🇪🇹
I'll begin with the ancient history ... and it goes way back. Because modern humans - and before that, the ancestors of humans - almost certainly originated in Ethiopia. 🇪🇹 (sub-thread):
The first likely historical reference to Ethiopia is ancient Egyptian records of trade expeditions to the "Land of Punt" in search of gold, ebony, ivory, incense, and wild animals, starting in c 2500 BC 🇪🇹
Ethiopians themselves believe that the Queen of Sheba, who visited Israel's King Solomon in the Bible (c 950 BC), came from Ethiopia (not Yemen, as others believe). Here she is meeting Solomon in a stain-glassed window in Addis Ababa's Holy Trinity Church. 🇪🇹
References to the Queen of Sheba are everywhere in Ethiopia. The national airline's frequent flier miles are even called "ShebaMiles". 🇪🇹
I'll begin with the ancient history ... and it goes way back. Because modern humans - and before that, the ancestors of humans - almost certainly originated in Ethiopia. 🇪🇹 (sub-thread):
The famous \u201cLucy\u201d, an early ancestor of modern humans (Australopithecus) that lived 3.2 million years ago, and was discovered in 1974 in Ethiopia, displayed in the national museum in Addis Ababa \U0001f1ea\U0001f1f9 pic.twitter.com/N3oWqk1SW2
— Patrick Chovanec (@prchovanec) November 9, 2018
The first likely historical reference to Ethiopia is ancient Egyptian records of trade expeditions to the "Land of Punt" in search of gold, ebony, ivory, incense, and wild animals, starting in c 2500 BC 🇪🇹
Ethiopians themselves believe that the Queen of Sheba, who visited Israel's King Solomon in the Bible (c 950 BC), came from Ethiopia (not Yemen, as others believe). Here she is meeting Solomon in a stain-glassed window in Addis Ababa's Holy Trinity Church. 🇪🇹
References to the Queen of Sheba are everywhere in Ethiopia. The national airline's frequent flier miles are even called "ShebaMiles". 🇪🇹
A list of cool websites you might now know about
A thread 🧵
1) Learn Anything - Search tools for knowledge discovery that helps you understand any topic through the most efficient
2) Grad Speeches - Discover the best commencement speeches.
This website is made by me
3) What does the Internet Think - Find out what the internet thinks about anything
4) https://t.co/vuhT6jVItx - Send notes that will self-destruct after being read.
A thread 🧵
1) Learn Anything - Search tools for knowledge discovery that helps you understand any topic through the most efficient
2) Grad Speeches - Discover the best commencement speeches.
This website is made by me
3) What does the Internet Think - Find out what the internet thinks about anything
4) https://t.co/vuhT6jVItx - Send notes that will self-destruct after being read.