Grammar and style

Grammar is how we construct sentences. Style is how we apply language rules for consistency and clarity.

Language and spelling

We write in English and use UK English spelling.

Voice and perspective

• Use active voice
  ✅ "Do this to activate the port"
  ❌ "The port is activated when you do this"

• Write in first-person
  ✅ “We are sorry.”
  ❌ “Console Connect is sorry.”

Structure and simplicity

• ✅ Use short, clear sentences
  Avoid: In order to ensure optimal configuration, please refer to the detailed documentation.
  Better: To configure it properly, check the support documentation.

• ✅ Be direct. Cut unnecessary words
  Avoid: Please be advised that you will need to log in prior to accessing this feature.
  Better: You need to log in to access this feature.

• ✅ Prefer simple verbs
  Use words like start, use, make — not initiate, utilize, or facilitate.
  Avoid: Utilize the dashboard to initiate provisioning.
  Better: Use the dashboard to start the service.

• ✅ Use consistent terminology
  Pick a term and stick to it (e.g. Click vs Press vs Hit).
  Avoid: Click the button, then press Save.
  Better: Click the button, then click Save.

• ✅ Keep paragraphs short
  Focus on one idea per paragraph.
  Avoid: You can view usage reports in the Analytics section. These show traffic patterns and let you set alerts.
  Better: View usage reports in the Analytics section.

Style rules

Capitalisation

• Use sentence case for all UI labels and body text. Only capitalise the first word in a sentence or label
  ✅ "Order a new service"
  ❌ "Order a New Service"

• Avoid ALL CAPS, unless for acronyms and proper nouns
  e.g. "VLAN", "BGP"

• Never use CamelCase

Apostrophes

• Use to show possession
  ✅ "Console Connect's software"

• Never use for plurals
  ❌ FAQ's

Lists

• Write full sentences.
• Capitalise the first word, end with a period.
• Use numbered lists only when order matters (e.g. steps in a process).

Numbers

• Write numbers under 10 in words (e.g. one, five).
• Use numerals for 10 and above (e.g. 10, 24).

Quotation marks

Use double quotes " " for:

• Direct speech.
• Technical terms or unusual phrasing.

Bandwidth notations

Use a space between the number and the unit for writing bandwidth.
✅ 10 Mbps
❌ 10Mbps

Contract duration

Contract duration is expressed in months and not years.
✅ 12 months, 24 months
❌ 1 year, 2 years

Date and time

Time format

• Use 24-hour time format with leading zeroes (e.g. 02:10, 23:11).
• Avoid using am/pm

Timestamps

• Show times in UTC by default, unless specified otherwise.
• When displaying date and time on the same line, the date comes first, followed by a comma and the time.

Example:

02 Jun 2020, 10:24

Date format

Always use the format: dd Mmm yyyy (e.g. 02 Jun 2021). Using abbreviated month names avoids confusion between international and US formats like 03/06/2021, which may be read as 3 June or 6 March depending on location.

Month abbreviations

Month	Abbreviation
January	Jan
February	Feb
March	Mar
April	Apr
May	May
June	Jun
July	Jul
August	Aug
September	Sep
October	Oct
November	Nov
December	Dec