1d00f3ef16
This User Experience personas are meant to help developers identify the target audience for their work. This is the first pass for the content. The intent is to provide the general information for all five personas in a consistent manner. Additional content such as infographics, comparison tables, etc., will be part of subsequent additions. Partial-bug: #1603420 Change-Id: I8fa4e0de762b97f44137c2ea48c0a9ee5b8bc61a Implements: blueprint ux-personas Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
41 lines
1.3 KiB
ReStructuredText
41 lines
1.3 KiB
ReStructuredText
.. _uitextguidelines:
|
|
|
|
==================
|
|
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.
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
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 :ref:`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.
|
|
* :ref:`Write in active voice<write_in_active_voice>`
|
|
* :ref:`Be clear and concise<be_clear_and_concise>`
|
|
* :ref:`Write objectively<write_objectively>`
|
|
* :ref:`Do not use contractions<do_not_use_contractions>`
|
|
* :ref:`Eliminate needless politeness<eliminate_needless_politeness>`
|
|
* :ref:`Use consistent terminology<use_consistent_terminology>`
|