Vale CMS Need more than a rule playground? Explore
Home

Public sector

Vale for the public sector

Plain English for the public, held to a government style guide.

Writing for the public has rules a product team’s docs don’t: plain English anyone can follow, words a government style guide tells you to avoid, acronyms defined the first time, and content that works with a screen reader. GOV.UK publishes its technical style guide as a Vale package any team can install, and the Readability, A11y, and alex packages check reading level, accessibility, and inclusive language on top.

Start with this config

The GOV.UK style installs by its release URL. Readability scores the reading level, A11y checks alt text, link text, and headings, and alex flags insensitive language. On a short page the readability scores fire as suggestions; raise MinAlertLevel to warning to see only the rest.

.vale.ini

StylesPath = styles
MinAlertLevel = suggestion
Packages = https://github.com/alphagov/tech-docs-linter/releases/latest/download/tech-writing-style-guide.zip, \
  Readability, A11y, alex

[content/*.md]
BasedOnStyles = Vale, tech-writing-style-guide, Readability, A11y, alex

Then download the packages it names and run Vale over the project:

$ vale sync
$ vale .

Formats

Where this kind of writing lives. Vale parses each one, so rules see the prose and skip the markup, the code, and the URLs.