Use standardized word-list terms (EK00040)
Use one accepted spelling per term to keep documentation consistent and searchable. Standardize variants such as e-mail or WiFi to the recommended form.
Using one accepted spelling for each term keeps your documentation consistent and easy to search. EkLine flags variant spellings that a standard word list settles — such as e-mail or WiFi — and suggests the recommended term (rule EK00040).
Why should you use consistent spelling in documentation?
Section titled “Why should you use consistent spelling in documentation?”Common terms have several accepted spellings — e-mail and email, WiFi and Wi-Fi — and mixing them within a project looks unedited. A standardized word list settles each choice, so writers don’t have to decide term by term. Consistent spelling also helps readers find content, whether they search for email or e-mail.
What EkLine flags
Section titled “What EkLine flags”EK00040 matches variant spellings that the Google style word list standardizes, such as “e-mail”, “WiFi”, and “cellphone”, and suggests the standard term.
- ❌ Incorrect: Send an e-mail.
- ✅ Correct: Send an email.
- ❌ Incorrect: Connect to WiFi.
- ✅ Correct: Connect to Wi-Fi.
How to fix
Section titled “How to fix”Accept the suggested standard term, or apply it yourself in place of the variant spelling.
Which spelling should you use for terms like email or Wi-Fi?
Section titled “Which spelling should you use for terms like email or Wi-Fi?”Use the standard form the word list settles on, such as email and Wi-Fi. Applying one spelling per term keeps content consistent and easier to search.
Does standardized spelling apply to brand names?
Section titled “Does standardized spelling apply to brand names?”No. When a variant spelling is part of a brand name or a direct quotation, keep it as written and ignore the rule for that line.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00040 |
| Category | Consistency |
| Default severity | Suggestion |
| Enabled by default | No |
Ignore this rule
Section titled “Ignore this rule”To keep a variant spelling on one line, add an inline comment:
<!-- ekline-ignore-next-line EK00040 -- preserves the original spelling in a quote -->The notice reads, "Send us an e-mail."To disable the rule across your project, add it to the ignore list in your configuration file.