3f4a614602
Adding structure and content for UI content guidelines within the Documentation Contributor Guide Co-Authored-By: Gudrun Wolfgram <gmolson@us.ibm.com> Change-Id: Ib315913a3149cc997be4e4f09fa67df626c07562 Implements: blueprint ui-content-guidelines
1.2 KiB
1.2 KiB
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
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>