Skip to main content
Version: Omada Identity on-premises 16.0.1

Documentation style guide

Consistency is key in technical writing. Our style guide provides a set of standards for grammar, punctuation, formatting, and tone to ensure that all documents maintain a unified voice and appearance.

The Microsoft Style Guide is our only source of truth

We follow the Microsoft Style Guide. It's our only source of truth for grammar, punctuation, capitalization, terminology, formatting, and word choice.

  • If you're in doubt, check the Microsoft Style Guide and follow it.
  • The pages in this section summarize the rules we use most often. They don't replace the Microsoft Style Guide, and they don't cover every case.
  • If anything in this section conflicts with the Microsoft Style Guide, follow the Microsoft Style Guide and report the conflict so that we can fix the page.

Omada-specific conventions​

The following conventions add to the Microsoft Style Guide. They cover cases that the Microsoft Style Guide doesn't specify, so they don't override it:

  • Write Omada Identity, not OI.
  • Embed examples in the sentence instead of putting them in a separate sentence. For details, see Text craft.
  • Use italic for setting values (such as True and False) and for the names of sections, documents, and guides.
  • Use the product names and terms from the Glossary, Abbreviations, and Product naming pages.
  • Add the third-party disclaimer to pages that reference third-party products. For details, see Procedures and instructions.