Avoid internet slang and abbreviations (EK00015)
Plain, spelled-out wording keeps your documentation clear for every reader, including newcomers who don't recognize casual shorthand.
Plain, spelled-out wording keeps documentation accessible to every reader, including those who don’t recognize casual shorthand. EkLine flags internet slang and abbreviations and suggests clearer wording (rule EK00015).
Why avoid internet slang in documentation?
Section titled “Why avoid internet slang in documentation?”Internet abbreviations assume shared context that many readers don’t have. A newcomer or a non-native English speaker may not know that “tl;dr” means “in short” or that “imo” means “in my opinion”. Spelling out the meaning removes the guesswork, keeps the tone professional, and makes your documentation easier to translate and search.
What EkLine flags
Section titled “What EkLine flags”EK00015 detects internet abbreviations such as tl;dr, imo, fwiw, rtfm, and ymmv.
- ❌ Incorrect: tl;dr: enable the flag.
- ✅ Correct: In short, enable the flag.
- ❌ Incorrect: imo this is faster.
- ✅ Correct: This is faster.
How to fix
Section titled “How to fix”Replace the abbreviation with plain wording, or remove it. Change “tl;dr” to “In short” and drop opinion markers like “imo”.
What counts as internet slang in documentation?
Section titled “What counts as internet slang in documentation?”Casual abbreviations such as “tl;dr”, “imo”, “fwiw”, “rtfm”, and “ymmv”. Each assumes shared context that many readers lack.
How do you replace tl;dr in a document?
Section titled “How do you replace tl;dr in a document?”Write a labeled “Summary” section, or open with “In short”. A clear heading serves the same purpose and reads professionally.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00015 |
| Category | Respectful language |
| Default severity | Error |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep an abbreviation on one line, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00015 -- quoting a community post verbatim -->The reply just said "rtfm" with a link to the guide.To disable the rule across your project, add it to the ignore list in your configuration file.