# Flesch–Kincaid readability score (EK00100)

import { Aside, Badge } from '@astrojs/starlight/components';

Readable documentation keeps sentences short and words plain, so a broad audience can follow it on the first read. EkLine measures the Flesch–Kincaid grade level of your content and flags text that reaches grade 8 or higher (rule EK00100), since the score rises with longer sentences and multi-syllable words.

## Why keep documentation readable?

Readability scores estimate how much effort a reader spends to follow your text. A grade 8 target keeps documentation accessible to a broad audience, including readers who work in a second language or skim under time pressure. Lower-grade writing also translates more cleanly and holds up better when readers move quickly through a procedure.

## What EkLine flags

EK00100 flags content whose Flesch–Kincaid grade level is 8 or higher. It measures the whole passage rather than matching individual words, so the fix is to lighten the sentences that raise the score.

- ❌ **Harder to read:** After you have finished the installation of the command-line interface and configured the authentication credentials that the service requires, you will be able to initiate a review of your entire documentation directory.
- ✅ **Easier to read:** Install the command-line interface and set up your credentials. You can then review your documentation directory.

## How to fix

Break long sentences into shorter ones, and give each sentence a single idea. Replace long, multi-syllable words with plainer alternatives to bring the grade level below 8.

<Aside type="tip">
Read a flagged sentence aloud. If you run out of breath before the end, split it into two.
</Aside>

## FAQ

### How do you lower the readability score?

Break long sentences into shorter ones, give each sentence a single idea, and replace multi-syllable words with plainer alternatives.

### What score should you aim for?

Aim for a Flesch–Kincaid grade level below 8, which keeps your documentation accessible to readers who skim or work in a second language.

## Rule details

| Property | Value |
|----------|-------|
| Rule ID | `EK00100` |
| Category | Readability metrics |
| Default severity | <Badge text="Suggestion" variant="note" /> |
| Enabled by default | No |

## Ignore this rule

To keep a dense passage on one line, add an inline comment with a reason:

```markdown
<!-- ekline-ignore-next-line EK00100 -- quoted regulatory text -->
The party of the first part shall indemnify and hold harmless the party of the second part.
```

To disable the rule across your project, add it to the `ignore` list in your [configuration file](/reviewer/configuration/ignoring-rules/#ignore).

## Related rules

- [EK00101](/reviewer/rules/ek00101/) — Gunning fog readability index
- [EK00021](/reviewer/rules/ek00021/) — Limit sentences to 32 words or fewer