Skip to main content
Version: On prem: 15.0.3

Style checklist

Use the following style checklist whenever you need to write something for the product. The following short guides, presented as a checklist, aim to assist you in developing consistent and clear content.

tip

For more detailed information, refer to the Text craft section.

Style checklist for developers​

When creating the UI content, answer the following questions:

  • Is the content clear?

  • Uses present tense?

  • Uses second person (You/Yours)?

  • Does not contain jargon?

  • Does not have big words?

  • Does not contain internal words?

  • Does not contain quotations marks (“”’’)?

  • Uses Omada Identity – avoid OI?

  • Does not use acronyms?

  • Avoids Latin abbreviations. Do you avoid e.g., etc.; and instead, use for example, that is, and so on?

  • Uses capitalization in:

    • First word of a sentence
    • Heading
    • Titles
    • UI labels

  • Does not use periods in:

    • Headings
    • Subheadings
    • UI Titles
    • UI text
    • Simple list or fewer words

Style checklist for technical writers​

When creating any type of content, adhere to the following guidelines:

The content must be:

  • Clear and direct

  • Human

  • Do not contain jargon

  • Do not have big words or overly long sentences

Spelling

  • Acronyms: Explain the acronym if it is the first time - RoPE (Role and Policy Engine).

  • Write Omada Identity – avoid OI.

  • Do not use acronyms in titles or headings.

  • Use sentence-style capitalization. Capitalize the first word of a sentence in a sentence, heading, titles, UI labels.

  • Use lowercase for everything else.

  • Capitalize the words joined by a slash (True/False).

  • Use the present tense.

  • Use the second person (You, yours).

  • Avoid Latin abbreviations. Avoid e.g., etc.; instead, use for example, that is, and so on.

  • Use bold format in:

    • Buttons
    • Markup language element
    • Tags
    • UI elements
    • Fields
    • Forms
    • Paths

  • Use italic format in:

    • New terms
    • Setting values (True/False)
    • Emphasis
    • Names of sections, documents, guides

Punctuation:

  • Colons: Use them when predicting a list and capitalize the word that follows it.

  • Numbers: Spell out the whole number from zero to nine.

  • Commas: Before conjunction, following, and introductory phrase, join independent clauses.

  • Em dash: Use it to emphases. Do NOT add spaces around em dash.

  • En dash: Use it to indicate a range of numbers, such as inclusive values.

  • Hyphens: Hyphenate two or more words that precede (built-in drive).

  • Ellipses: Do not use it, only to indicate omitted text.

  • Periods: Do not use them in:

    • Headings
    • Subheadings
    • UI Titles
    • UI text
    • Simple list or fewer words

  • Quotation marks: Use single quotation marks (' ') DO not use double (" ").