Writing style guide

For technical instructions, see Authoring articles

Most writing style guidelines are covered by the Vale and Alex linters, which are automatically run for all pull request. You can also configure them locally, to get immediate feedback while writing articles. See Writing style guide checks for instructions.

The following guidelines are not covered by the automated checks.

General writing

American English

Use American English (U.S. English, en-US).

For example:

• "customize" instead of "customise".
• "center" instead of "centre"
• "color" instead of "colour"

Heading case (title vs sentence)

Use Title Case in:

• Article title (front matter, for example, title: Article Title)
• Article headings (H1-H6, for example == Section Heading)

Use Sentence case in example UI texts (for example, button and field labels, error messages, section headings, navigation items).

Vale checks that title case is used for article headings, but other uses need manual verification.