UI text guidelines

User interface (UI) text guidelines are intended for designers, developers, or reviewers contributing content within OpenStack user interfaces. Use these text guidelines to ensure that the OpenStack interface is usable, consistent, and concise.

• Follow UI text capitalization guidelines
  • Capitalization style for common UI elements
  • UI capitalization cheat sheet
• Use recommended UI action labels
• Follow UI alert guidelines
  • General alert guidelines
  • Alert structure for new danger (error) conditions
  • Alert examples
• Use recommended UI panel formatting
  • Workflow navigation text
  • Icons

In addition to these resources, ensure you review the Writing style section. The general writing style guidelines also apply to content in the user interface.

Top Tips

Use these tips and quick links to access UI text guidance reminders.

• Avoid abbreviations, acronyms, and slang. Unless the abbreviation is better known than the word it stands for or space savings is critical.

• Write in active voice

• Be clear and concise

• Write objectively

• Do not use contractions

• Eliminate needless politeness

• Use consistent terminology