openstack/openstack-manuals
Code Issues Proposed changes
e1e00f51c8
openstack-manuals/doc/contributor-guide/source/ui-text-guidelines.rst
Linette 84328b35e7 Enhance UI content guidelines 
Added content for consistent text/icon
formatting in the UI. Also, included
considerations for when to use text vs
icons.

Change-Id: I0951e1b5c3c5dedfea7e0d873016e6e231864e2a
Implements: blueprint ui-content-guidelines
2016-02-23 09:07:41 -06:00

1.3 KiB
Raw Blame History

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.

ui-text-guidelines/ui-text-capitalization.rst ui-text-guidelines/ui-action-labels.rst ui-text-guidelines/ui-error-messages.rst ui-text-guidelines/ui-panel-formatting.rst

In addition to these resources, ensure you review the stg_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<write_in_active_voice>
  • Be clear and concise<be_clear_and_concise>
  • Write objectively<write_objectively>
  • Do not use contractions<do_not_use_contractions>
  • Eliminate needless politeness<eliminate_needless_politeness>
  • Use consistent terminology<use_consistent_terminology>