VBC-935: colloquial-language

warning

Category: docs
Analysis: Regex (line by line)
File types: .md, .txt
Scope: source code only, ignoring anything inside strings and comments
Off by default. Name it in slopless.config.json to turn it on.
Tags: docs style

What it reports

Corporate colloquialism or buzzword '{match}' in documentation at line {line}. Jargon and idioms are confusing for non-native English speakers and make documentation sound unprofessional. Use plain, direct language.

Flagged

Let's circle back on the deep dive.

Not flagged

We will review the design on Tuesday.

Pattern

\b(touch base|circle back|deep dive|low-hanging fruit|move the needle|game changer|paradigm shift|the whole nine yards|ballpark figure|boil the ocean|drink the kool-aid|drink the koolaid)\b