Prefer American over British spelling (EK00001)
American English spelling keeps your documentation consistent with the tools and libraries readers use. Learn why to prefer it over British spelling.
American English spelling keeps a single convention running through your documentation, so words like color and organize don’t compete with colour and organise. EkLine flags British spellings (rule EK00001) and suggests the American equivalent so you can standardize your text.
Why use American spelling in documentation?
Section titled “Why use American spelling in documentation?”Mixed spelling conventions make documentation look unedited and distract technical readers. Most software and API documentation follows American English, and matching that expectation keeps your content consistent with the tools, error messages, and libraries your readers already use. Consistent spelling also improves search: readers who search for initialize shouldn’t miss a page that only says initialise.
What EkLine flags
Section titled “What EkLine flags”EK00001 matches British spellings anywhere in your text, regardless of case, and suggests the American form.
- ❌ Incorrect: Choose your favourite colour from the palette.
- ✅ Correct: Choose your favorite color from the palette.
- ❌ Incorrect: Authorise the request before you initialise the client.
- ✅ Correct: Authorize the request before you initialize the client.
How to fix
Section titled “How to fix”Accept the suggested American spelling, or apply it yourself. When a British spelling is intentional — for example, in a product name, a quotation, or a proper noun — keep it and silence the rule for that content.
Is American or British spelling better for documentation?
Section titled “Is American or British spelling better for documentation?”Neither is more correct, but most software and API documentation follows American English. Matching that convention keeps your content consistent with the tools, error messages, and libraries your readers already use.
Can you keep a British spelling on purpose?
Section titled “Can you keep a British spelling on purpose?”Yes. When a British spelling belongs to a brand name, a quotation, or a proper noun, keep it and ignore the rule for that line.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00001 |
| Category | Spelling and grammar |
| Default severity | Warning |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep a flagged spelling on one line, add an inline comment:
<!-- ekline-ignore-next-line EK00001 -- proper noun -->Read about the Behaviour Driven Development framework.To disable the rule across your project, add it to the ignore list in your configuration file.