Style Guide

Consistency of the OpenActive brand name and specs

"OpenActive" must always be referenced as "OpenActive", rather than "OA" or "Open Active".

When OpenActive is included in a URL path, it should be styled "openactive", rather than "open-active" or "open_active".

Real-time Paged Data Exchange feeds must always be referred to as the "RPDE feeds", rather than "OpenActive feeds" or "feeds".

The Modelling Opportunity Data specification must always be referred to as the "Modelling specification".

Implementations of the Open Booking API must always be referred to as the "Open Booking API", rather than "OBA" or "Open Booking".

Naming of data model terms

The OpenActive Vocabulary is based on schema.org, and therefore the schema.org style guide must be followed for all data model terms (all OpenActive Vocabulary terms, beta terms, and extension terms), as any of these may be considered for inclusion by schema.org in future.

Use of US and UK English spellings

The schema.org style guide states "US spellings must be used", therefore all data model terms must use US spelling.

Except when referencing Vocabulary terms, OpenActive documentation and specifications are written using UK English spellings.

General writing guidelines

The OpenStack guidelines must be applied when writing documentation.