Documentation

Documentation

Style Guide

Key Facts

Here is a brief list of the most important points to bear in mind when contributing to documentation. You can find much more detail in the main sections of this guide.

  • Each section should have a header with title and menu order

  • Write one sentence per line in AsciiDoc

  • Write for accessibility

  • Write for a global audience

  • Use title case in headings

  • Use capitals only when necessary

  • Do not use contractions (don’t, isn’t, can’t, and so on)

  • Use passive voice only when necessary

  • Do not use ampersand (&) as a synonym for and

  • Do not use slang or colloquial language

Topics