Enable dictionary-based spell checking (EK00300)
Catch typos before they reach readers. Learn how dictionary-based spell checking flags misspellings in your documentation and how to extend it.
Spell checking is the most basic quality gate, so running it on every review keeps misspellings out of your published documentation. EkLine checks each word against its dictionary and flags anything it doesn’t recognize as a possible typo (rule EK00300), such as responce for response or recieve for receive.
Why spell check your documentation?
Section titled “Why spell check your documentation?”A single typo undermines trust in otherwise accurate documentation. Spell checking is the most basic quality gate, and running it automatically on every review means no misspelling reaches a published page. Because technical writing is full of product names and jargon, EkLine lets you extend the dictionary so real terms don’t get flagged.
What EkLine flags
Section titled “What EkLine flags”EK00300 flags any word that isn’t in its dictionary.
- ❌ Incorrect: The API returns a
responceobject. - ✅ Correct: The API returns a
responseobject. - ❌ Incorrect: You will recieve a confirmation.
- ✅ Correct: You will receive a confirmation.
Product names, acronyms, and technical terms that aren’t dictionary words are also flagged until you add them to your dictionary.
How to fix
Section titled “How to fix”- For a genuine typo, correct the spelling.
- For a valid term that EkLine doesn’t recognize — such as a product name or an API field — add it to your dictionary so it’s accepted everywhere.
How do you stop a valid term from being flagged?
Section titled “How do you stop a valid term from being flagged?”Add the term — such as a product name or an API field — to your dictionary. A shared dictionary accepts it everywhere and keeps terminology consistent.
What kinds of misspellings does spell checking catch?
Section titled “What kinds of misspellings does spell checking catch?”It catches typos that slip past a quick read, such as responce for response or recieve for receive.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00300 |
| Category | Spelling and grammar |
| Default severity | Error |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep a flagged word on one line — for example, a deliberate misspelling in a quotation — add an inline comment:
<!-- ekline-ignore-next-line EK00300 -- customer testimonial, preserve original spelling -->"I definately love this product!" - Jane D.To accept a term everywhere, prefer adding it to your dictionary over disabling the rule.