85107272be
Based off conversation at the PTG, we agreed it would be beneficial to ensure the contrib-guide is clearly marked as the doc contrib guide outside of the title. This change includes a redirect. Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
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>`
|