Style guide

Conventions for a consistent, unified approach to layout and style throughout the user interface

Tooltips

Tooltips provide brief, contextual help for UI elements. They should be concise, scannable, and easy to understand.

Tone:

• Use a clear, neutral, and instructional tone.

• Avoid jargon, unless it is widely understood by users.

Length:

• Aim for one sentence or less.

• Avoid multiple sentences or blocks of text.

Punctuation:

• Do not use ending punctuation (like periods) for short phrases or fragments. Example: "Displays on the learner's dashboard"

• Use a period if the tooltip is a complete sentence. Example: "This text appears under the achievement title."

Grammar:

• Use sentence case (capitalize the first word).

• Use active voice when possible.

Examples:

• ❌ "this text will be shown under the achievement title."

• ✅ "This text appears under the achievement title."

• ✅ "Appears under the achievement title"