Vale CMS Need more than a rule playground? Explore

What the style guides say

“rtfm”

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

The advice

Leave it out, or rephrase

Guide by guide

  • Google Avoid it Slang · error
  • Grafana Avoid it Google slang · error

No rule names it in Microsoft, Red Hat, IBM, GitLab, Elastic, Datadog, Splunk, Salesforce, Docker, 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.