diff options
author | Victor Wu <wu.victor@gmail.com> | 2016-11-16 21:29:28 +0000 |
---|---|---|
committer | awhildy <allison@gitlab.com> | 2016-11-17 13:47:02 -0800 |
commit | cfabd5b5a9fb47b68210683c813efc36e9e1d921 (patch) | |
tree | 0548ffbf922a5076962b837e7726285d0fabfbbc /doc/development | |
parent | 400d2b7e5d5cf7ebecadb5cddd293af5728a8c8b (diff) | |
download | gitlab-ce-cfabd5b5a9fb47b68210683c813efc36e9e1d921.tar.gz |
Update copy.md with issue guideline updates and merge request guidelines
Update examples and labels to use sentence case.
Update copy.md [ci skip]
Update copy.md [ci skip]
Update copy.md
Diffstat (limited to 'doc/development')
-rw-r--r-- | doc/development/ux_guide/copy.md | 73 |
1 files changed, 47 insertions, 26 deletions
diff --git a/doc/development/ux_guide/copy.md b/doc/development/ux_guide/copy.md index 03392a003ee..227b4fd3451 100644 --- a/doc/development/ux_guide/copy.md +++ b/doc/development/ux_guide/copy.md @@ -7,7 +7,7 @@ We are currently inconsistent with this guidance. Images below are created to il ## Contents * [Brevity](#brevity) -* [Forms](#forms) +* [Sentence case](#sentence-case) * [Terminology](#terminology) --- @@ -27,52 +27,73 @@ Preferrably use context and placement of controls to make it obvious what clicki --- -## Forms +## Sentence case +Use sentence case for all titles, headings, labels, menu items, and buttons. -### Adding items +--- + +## Terminology +Only use the terms in the tables below. + +### Issues + +#### Adjectives (states) + +| Term | +| ---- | +| Open | +| Closed | +| Deleted | + +>**Example:** +Use `5 open issues` and don't use `5 pending issues`. + +#### Verbs (actions) + +| Term | Use | Don't | +| ---- | --- | --- | +| Add | Add an issue | Don't use `create` or `new` | +| View | View an open or closed issue || +| Edit | Edit an open or closed issue | Don't use `update` | +| Close | Close an open issue || +| Re-open | Re-open a closed issue | There should never be a need to use `open` as a verb | +| Delete | Delete an open or closed issue || + +#### Add issue When viewing a list of issues, there is a button that is labeled `Add`. Given the context in the example, it is clearly referring to issues. If the context were not clear enough, the label could be `Add issue`. Clicking the button will bring you to the `Add issue` form. Other add flows should be similar. ![Add issue button](img/copy-form-addissuebutton.png) -The form should be titled `Add issue`. The submit button should be labeled `Save` or `Submit`. Do not use `Add`, `Create`, `New`, or `Save Changes`. The cancel button should be labeled `Cancel`. Do not use `Back`. +The form should be titled `Add issue`. The submit button should be labeled `Submit`. Don't use `Add`, `Create`, `New`, or `Save changes`. The cancel button should be labeled `Cancel`. Don't use `Back`. ![Add issue form](img/copy-form-addissueform.png) -### Editing items +#### Edit issue When in context of an issue, the affordance to edit it is labeled `Edit`. If the context is not clear enough, `Edit issue` could be considered. Other edit flows should be similar. ![Edit issue button](img/copy-form-editissuebutton.png) -The form should be titled `Edit Issue`. The submit button should be labeled `Save`. Do not use `Edit`, `Update`, `New`, or `Save Changes`. The cancel button should be labeled `Cancel`. Do not use `Back`. +The form should be titled `Edit issue`. The submit button should be labeled `Save`. Don't use `Edit`, `Update`, `Submit`, or `Save changes`. The cancel button should be labeled `Cancel`. Don't use `Back`. ![Edit issue form](img/copy-form-editissueform.png) ---- - -## Terminology -### Issues +### Merge requests #### Adjectives (states) -| Term | Use | -| ---- | --- | -| Open | Issue is active | -| Closed | Issue is no longer active | - ->**Example:** -Use `5 open issues` and do not use `5 pending issues`. -Only use the adjectives in the table above. +| Term | +| ---- | +| Open | +| Merged | #### Verbs (actions) -| Term | Use | -| ---- | --- | -| Add | For adding an issue. Do not use `create` or `new` | -| View | View an issue | -| Edit | Edit an issue. Do not use `update` | -| Close | Closing an issue | -| Re-open | Re-open an issue. There should never be a need to use `open` as a verb | -| Delete | Deleting an issue. Do not use `remove` |
\ No newline at end of file +| Term | Use | Don't | +| ---- | --- | --- | +| Add | Add a merge request | Do not use `create` or `new` | +| View | View an open or merged merge request || +| Edit | Edit an open or merged merge request| Do not use `update` | +| Merge | Merge an open merge request ||
\ No newline at end of file |