Vale CMS Need more than a rule playground? Explore

Open-source project

Canonical documentation style guide

26 rules across 4 topics, naming 72 terms.

  • 5 errors
  • 10 warnings
  • 11 suggestions
Read at
705da79
License
CC-BY-SA-4.0

The guide, by topic

Select a rule to see what it asks for.

Word choice

21 rules · preferred terms, jargon, and words to avoid

Concision

1 rule · long sentences, filler, and wordy phrases

Voice and tone

1 rule · person, tense, contractions, and claims

Headings

3 rules · capitalization and punctuation in titles

The word list

Every term this guide’s rules name, and what it says to write instead.

Instead ofWrite
AnboxAnbox
AwsAWS
billionAvoid it
Canononical Observability StackCanonical Observability Stack
chairmanAvoid it
CharmedCharmed
circa'around' or 'near'
CloudCloud
dockerDocker
eighteenAvoid it
eightyAvoid it
elevenAvoid it
ergo'therefore' or 'hence'
fifteenAvoid it
fiftyAvoid it
foremanAvoid it
fortyAvoid it
fourteenAvoid it
gonnagoing to
Google cloudGoogle Cloud Platform
Google cloud platformGoogle Cloud Platform
gottagot to
gratis'free'
hundredAvoid it
InfluxdbInfluxDB
JujuJuju
KubeflowKubeflow
KubeFlowKubeflow
KuberentesKubernetes
LaunchpadLaunchpad
LXDLXD
MAASMAAS
mannedAvoid it
mattermostMattermost
MicroCephMicroCeph
MicroCloudMicroCloud
MicroK8sMicroK8s
MicroOVNMicroOVN
MicroStackMicroStack
middlemanAvoid it
millionAvoid it
MultipassMultipass
MysqlMySQL
nineteenAvoid it
ninetyAvoid it
nVidiaNVIDIA
Observability StackObservability Stack
OpenstackOpenStack
PostgresqlPostgreSQL
ProPro
proviso'condition' or 'provided that'
sanity checkAvoid it
seventeenAvoid it
seventyAvoid it
sicAvoid it
sixteenAvoid it
sixtyAvoid it
SnapcraftSnapcraft
snapdsnapd
stanza'division', 'block', or 'paragraph'

These rules run in Vale, which checks a whole documentation set against a guide in your editor and on every pull request.

All 16 guides