Readability¶

Good writing encompasses many aspects. Apart from concise content, your texts need a balanced mixture of long and short sentences. Furthermore you should refrain from too many complex and difficult words. Additionally, it is always good to make sure that your paragraphs are not too long, use active voice, and structure your paragraphs accordingly.

Since the development of text, humanity's creativity has brought forth many tips to good writing. While Zettlr provides you with the perfect environment to write in, thereby making sure the legibility of your text is great, the readability is something you need to take care of as well. Luckily Zettlr has a tool for you: The readability mode.

Please note that the readability score is only one out of several measurables that can help you determine the ease of reading. It should not be taken too seriously. If the readability algorithm highlights a sentence in deep red, this does not necessarily mean that you should rewrite the sentence. Rather, look at the context of the sentence, which the algorithm does not take into account, to determine the quality of a sentence. We recommend to first write your text without the mode, and then only switching it on for some passages where you have a feeling they might be difficult to understand.

What the Readability Mode does¶

In its shortest definition, the readability mode is a syntax highlighting mode for CodeMirror that calculates a basic score for each of your sentences, giving you a first impression of the readability of your texts. It highlights each of your sentences with a colour ranging from green to red, where green means that the sentence is easy to understand, while red means that the sentence is hard to understand.

The mode has four different algorithms at its disposal: The Dale-Chall readability formula, the Gunning-Fog index, the Coleman-Liau index, and the Automated Readability index. These differ in what they estimate to be hard to understand writing, and in the "harshness" of the scores they give to sentences. Not all indices are a good choice for every text. You need to choose the algorithms wisely.

Note that all of the implemented readability algorithms have been designed with English in mind. Zettlr attempts to make them work with other languages as well using newer research, but the algorithms will still be biased towards English. Non-western scripts such as Korean, Chinese, or Japanese, don't work with these scores. If you know of readability algorithms that do work with other scripts, please notify us so we can make Zettlr more universal in this regard!

Dale-Chall Readability Formula¶

The Dale-Chall formula was created in the early days of educational research and was authored by Edgar Dale and Jeanne Chall. Its aim was to provide a measurable to determine the readability of texts for school children. It uses a list of 3.000 words that are easy to understand for American fourth-graders and gives a score that approximately ranges from 0 to 10, which roughly translates to the years of education needed to understand a text. That means: If a sentence receives a 10, you'd need a college degree to understand the text, while a sentence with a 1 could be understood by beginners.

Use Dale-Chall if you are writing texts for a broader audience, as the algorithm will give your text credit for short and concise sentences without pushing you to ridiculously short sentences.

Gunning-Fog index¶

Gunning-Fog has been created in the early days of tabloid and easy reading. In 1952, Robert Gunning was searching for a way to make the books and newspapers he was publishing measurable. The Gunning-Fog index returns a score that correlates approximately with the years of formal education needed for a reader to understand a text. Still, being a businessman and therefore interested in a high dispersion of his publications, Gunning's algorithm tends to give high scores even to relatively easy to understand texts. If you cycle through the different algorithms, you will note that Gunning-Fog tends to paint everything ~~black~~ red.

Use Gunning-Fog if you want to write short advertisement texts (e.g., for websites) that cannot count on an even basic intrinsic motivation to read.

Coleman/Liau index¶

With the plunge of computer prices, computer-aided statistics became a popular option to process huge amounts of data and spit out a meaningful measurable. The Coleman/Liau index is from this era and is an algorithm that does not rely on syllable counts or lists with "difficult words". Therefore, the Coleman/Liau-index is extremely accurate in its implementation in Zettlr. As do the others, it gives a score that approximates the years of formal education needed to comprehend a sentence. Additionally, Coleman/Liau gives reasonable results and does not penalise slightly longer sentences very much.

Use Coleman/Liau if you need an accurate measurement of the readability of any text. It does not go well with one-word-sentences, but will give reasonable scores even for harder to understand texts.

Automated Readability Index (ARI)¶

The Automated Readability Index is in alignment with Coleman/Liau, as it is a newer formula to calculate readability scores based on simple statistical analysis. It is the most "forgiving" of the algorithms and produces results that do not prompt you to re-write half of your text because of a red highlighting colour.

Use the ARI if you are writing more demanding texts such as academic papers, as it will give better scores even for some difficult sentences.

A Note on "Difficult Words"¶

In its own implementation, Zettlr does not ship with a list of easy to comprehend words that the Dale-Chall requires. Instead, it uses a different approach. The list of easy to understand words differs from time to time and, obviously, from language to language. Therefore, Zettlr takes into account another measurable to determine words deemed difficult: Language variance.

Difficult words for Zettlr are defined as being longer than two times the standard deviation of the average word length. As Coleman and Liau have put it in their 1975 paper A Computer Readability Formula Designed for Machine Scoring, the length of words is a much better indicator for the difficulty of words than the number of syllables. Therefore, the algorithms can score sentences in any western script language, not only English. You can look up the algorithm explanation on our readability feature page.

Additionally, Zettlr makes one more change to the algorithms: While all four algorithms were devised to be applied to full texts, the readability mode will take each sentence, one at a time, and therefore leave out their context. In general this approximates the difficulty of the sentence, but obviously may mark some sentences as green that are difficult to understand in their given context, while it will mark some sentences red that still fit into the given context.