Prefer concise words over complex terms (EK00042)
Concise phrasing removes filler and gets readers to the point faster. Replace wordy phrases with shorter equivalents to keep documentation tight and clear.
Concise phrasing removes filler and gets readers to the point faster. EkLine flags a wordy phrase that has a shorter equivalent and suggests the concise term (rule EK00042).
Why does concise wording matter in documentation?
Section titled “Why does concise wording matter in documentation?”Wordy phrases like a number of add length without adding meaning, and they accumulate across a document. Tighter phrasing respects the reader’s time and makes each sentence easier to scan. Concise words also translate more predictably.
What EkLine flags
Section titled “What EkLine flags”EK00042 flags a wordy phrase that has a shorter equivalent.
- ❌ Incorrect: a number of options
- ✅ Correct: several options
- ❌ Incorrect: a majority of users
- ✅ Correct: most users
- ❌ Incorrect: Long timeouts adversely impact performance.
- ✅ Correct: Long timeouts hurt performance.
How to fix
Section titled “How to fix”Replace the flagged phrase with the concise term EkLine suggests.
How do you make documentation more concise?
Section titled “How do you make documentation more concise?”Replace wordy phrases with shorter equivalents — “a number of” becomes “several”, and “a majority of” becomes “most”. Each swap trims length without losing meaning.
Why does concise writing help readers?
Section titled “Why does concise writing help readers?”Tighter phrasing respects the reader’s time, makes each sentence easier to scan, and translates more predictably.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00042 |
| Category | Sentences and phrases |
| Default severity | Suggestion |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep a flagged phrase on one line, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00042 -- quoted survey question, preserve wording -->"How would a number of outages affect your team?"To disable the rule across your project, add it to the ignore list in your configuration file.