Vale CMS Need more than a rule playground? Explore

What the style guides say

“please”

8 of 16 open style guides have a rule about “please.” None of them names a replacement: the advice is to cut it or rephrase.

The advice

Leave it out, or rephrase

Guide by guide

  • Red Hat Do not use "please" in technical documentation. Do not use terms · warning
  • IBM Avoid it Usage · warning
  • GitLab Use 'please' only if we've inconvenienced the user. Wordy · suggestion
  • Grafana Avoid it Please · error
  • Elastic Avoid it Dont use · warning
  • Datadog Avoid it words_case_insensitive · warning
  • Splunk Avoid it Dont use · warning
  • Docker Avoid it Avoid · warning

No rule names it in Google, Microsoft, Salesforce, Canonical, Apify, Spectro Cloud, 18F, GOV.UK. That doesn’t mean those guides approve of it, only that no rule lists it.

Catch it in every draft

Each line above is a rule one of these organizations publishes for Vale, an open-source linter for prose. Install a guide’s rules and Vale flags the term wherever it appears, in your editor and on every pull request.