Jargon

warning

Type substitution Categorysubstitution

Prefer [matched text] over [matched text].

Use plain language that every reader can understand. Replace jargon and unnecessarily complex phrasing with simpler alternatives.

Guiding principle

If a shorter, plainer word means the same thing, use it. Documentation is not the place to demonstrate vocabulary. Write at a level that a new team member can follow without a glossary.

Replacement Table

Avoid	Prefer
`a large number of`	`many`
`at this point in time`	`now`
`due to the fact that`	`because`
`functionality`	`feature`
`in order to`	`to`
`in the event that`	`if`
`leverage`	`use`
`prior to`	`before`
`subsequent to`	`after`
`utilize`	`use`

Settings

Case-insensitive: Yes

Technical Details

Message template: Prefer '%s' over '%s'.
Extends: substitution
Severity: warning