UI Guidelines Section in the OpenStack Documentation Contributor Guide
The OpenStack UX project is interested in adding a section to the OpenStack Documentation Contributor Guide that provides guidance on maintaining consistent structure, style, and syntax for any graphical user interfaces (GUI) developed by the OpenStack project teams. The guide could be applied to IA efforts for the panel headings, modal headings, modal section headings, section descriptions, labels, etc.
The value of this effort is to help provide a improved usability for operators, admins and end users.
Whiteboard
Working Etherpad: https:/
Proposed TOC:
UI content guidelines (Intro / Value statement)
1. Follow text capitalization guidelines in UI
a. Examples of sentence-style capitalization
b. Examples of headline-style capitalization
c. Common UI elements/headings that use sentence-style capitalization
d. Common UI elements/headings that use headline-style capitalization
e. UA cheat sheet (visual)
2. Use recommended labels in UI
a. Common action labels (i.e. Cancel, Add, Close, Delete, etc...),
b. Other common labels (i.e. IP address)
3. Refer to user interface elements consistently (provide overview and link to ui-terminology.html in
Contributor Guide)
4. Follow writing style guidelines (provide overview and link to Writing Style section in Contributor
Guide)
5. Follow error message guidelines for UI (structure, clarity, completeness)
a. structure definitions
b. examples
Gerrit topic: https:/
Addressed by: https:/
[ui-
Addressed by: https:/
[ui-
Addressed by: https:/
[WIP] Enhance UI content guidelines