@@ -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.
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`.
### 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.
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`.
