Use inclusive technical terms (EK00035)
Inclusive technical terms such as allowlist and main describe their function and match modern conventions. Learn why to use them in documentation.
Inclusive technical terms describe what each one does, such as allowlist for whitelist and main for master, which keeps your documentation precise and aligned with current industry conventions. EkLine flags non-inclusive technical terms and suggests a clearer replacement (rule EK00035).
Why use inclusive technical terms in documentation?
Section titled “Why use inclusive technical terms in documentation?”Terms like “whitelist” and “blacklist” rely on color to signal allowed or blocked, which is less descriptive than “allowlist” and “blocklist”. The inclusive alternatives state the function directly, so a new reader understands them without prior context. Major platforms and language ecosystems have already adopted these terms, so matching them keeps your documentation consistent with the tools your readers use.
What EkLine flags
Section titled “What EkLine flags”EK00035 matches non-inclusive technical terms and suggests an inclusive replacement.
- ❌ Incorrect: Add the IP to the whitelist.
- ✅ Correct: Add the IP to the allowlist.
- ❌ Incorrect: Deploy from the master branch.
- ✅ Correct: Deploy from the main branch.
How to fix
Section titled “How to fix”Replace the flagged term with the suggested equivalent: “blacklist” becomes “blocklist”, “whitelist” becomes “allowlist”, “master” becomes “main” or “primary”, “slave” becomes “replica” or “secondary”, and “grandfathered” becomes “exempt”.
What should you use instead of “whitelist” and “blacklist”?
Section titled “What should you use instead of “whitelist” and “blacklist”?”Use “allowlist” and “blocklist”. These terms state the function directly, so a new reader understands them without prior context.
What replaces “master” and “slave” in technical writing?
Section titled “What replaces “master” and “slave” in technical writing?”Use “main” or “primary” for “master”, and “replica” or “secondary” for “slave”. Major platforms and language ecosystems have already adopted these terms.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00035 |
| Category | Inclusive language |
| Default severity | Error |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep a flagged term on one line, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00035 -- third-party API field name -->Set the `master_key` field required by the payment provider.To disable the rule across your project, add it to the ignore list in your configuration file.