diff options
author | awhildy <allison@gitlab.com> | 2016-10-21 14:25:09 -0700 |
---|---|---|
committer | awhildy <allison@gitlab.com> | 2016-11-10 14:09:35 -0800 |
commit | 11510bf729e04ea6f4a713820582b490266505d2 (patch) | |
tree | 6a822073373f36673ce6b390744ba143915daa90 /doc/development/ux_guide/basics.md | |
parent | a3fd8521fb036b1f7153cad58234e8cb08246278 (diff) | |
download | gitlab-ce-ux-guide-restructure.tar.gz |
[ci skip] Establish basic structure for ux_guide README.mdux-guide-restructure
Block out pages needed for ux_guide
Add resources stub to ux_guide home
Fill out principles and basics
Add TOC to basics
Move all of UI guide to new UX guide structure
Add first level structure on ux-guide pages
Add more details to buttons
Add button images. Update link on development
Renamed surfaces to templates. Add tooltip details
Update typography and icons on Basics page
Add images for color. First draft of voice and tone
Delete findings page
Refine pages. Fill out Surfaces pages
Clean up layout on basics, surfaces, features. Add anchorlinks and counts to components
Fill out components page
Add item title and system info block
Fill out Features page
Switch tooltip placement image
Diffstat (limited to 'doc/development/ux_guide/basics.md')
-rw-r--r-- | doc/development/ux_guide/basics.md | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/doc/development/ux_guide/basics.md b/doc/development/ux_guide/basics.md new file mode 100644 index 00000000000..7e7cb103694 --- /dev/null +++ b/doc/development/ux_guide/basics.md @@ -0,0 +1,112 @@ +# Basics + +## Contents +* [Responsive](#responsive) +* [Typography](#typography) +* [Icons](#icons) +* [Color](#color) +* [Motion](#motion) +* [Voice and tone](#voice-and-tone) + +--- + +<br> + +## Responsive +GitLab is a responsive experience that works well across all screen sizes, from mobile devices to large monitors. In order to provide a great user experience, the core functionality (browsing files, creating issues, writing comments, etc.) must be available at all resolutions. However, due to size limitations, some secondary functionality may be hidden on smaller screens. Please keep this functionality limited to rare actions that aren't expected to be needed on small devices. + +--- + +<br> + +## Typography +### Primary typeface +GitLab's main typeface used throughout the UI is **Source Sans Pro**. We support both the bold and regular weight. + + + + +### Monospace typeface +This is the typeface used for code blocks. GitLab uses the OS default font. +- **Menlo** (Mac) +- **Consolas** (Windows) +- **Liberation Mono** (Linux) + + + +--- + +<br> + +## Icons +GitLab uses Font Awesome icons throughout our interface. + + +The trash icon is used for destructive actions that deletes information. + + +The pencil icon is used for editing content such as comments. + + +The bell icon is for notifications, such as Todos. + + +The eye icon is for subscribing to updates. For example, you can subscribe to a label and get updated on issues with that label. + + +The standard RSS icon is used for linking to RSS/atom feeds. + + +An 'x' is used for closing UI elements such as dropdowns. + + +A plus is used when creating new objects, such as issues, projects, etc. + +>>> +TODO: update this section, add more general guidance to icon usage and personality, etc. +>>> + +--- + +<br> + +## Color + + +Blue is used to highlight primary active elements (such as current tab), as well as other organization and managing commands. + + +Green is for actions that create new objects. + + +Orange is used for warnings + + +Red is reserved for delete and other destructive commands + + +Grey, and white (depending on context) is used for netral, secondary elements + +>>> +TODO: Establish a perspective for color in terms of our personality and rationalize with Marketing usage. +>>> + +--- + +<br> + +## Motion + +Motion is a tool to help convey important relationships, changes or transitions between elements. It should be used sparingly and intentionally, highlighting the right elements at the right moment. + +>>> +TODO: Determine a more concrete perspective on motion, create consistent easing/timing curves to follow. +>>> + +--- + +<br> + +## Voice and tone + +The copy for GitLab is clear and direct. We strike a clear balance between professional and friendly. We can empathesize with users (such as celebrating completing all Todos), and remain respectful of the importance of the work. We are that trusted, friendly coworker that is helpful and understanding.
\ No newline at end of file |