summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Wu <wu.victor@gmail.com>2016-11-14 19:46:02 +0000
committerVictor Wu <wu.victor@gmail.com>2016-11-14 19:46:02 +0000
commit826d668c3b9917c343c0ebe75e3b3b7dceb14e77 (patch)
treecbada27a406309930f0e321bdf4c0b9e0f3fe168
parent84e1366151af635fda6f674496a44a4baeb1215b (diff)
downloadgitlab-ce-copy-messaging-guidelines.tar.gz
Add forms to guidelinescopy-messaging-guidelines
-rw-r--r--doc/development/ux_guide/copy.md39
1 files changed, 36 insertions, 3 deletions
diff --git a/doc/development/ux_guide/copy.md b/doc/development/ux_guide/copy.md
index 7a86dcd160f..46bbf7565de 100644
--- a/doc/development/ux_guide/copy.md
+++ b/doc/development/ux_guide/copy.md
@@ -4,6 +4,7 @@ The primary purpose of copy is of course serving the user experience as part of
## Contents
* [Brevity](#brevity)
+* [Forms](#forms)
* [Issues](#issues)
---
@@ -22,6 +23,38 @@ If the context and placement of the button makes it obvious that clicking the bu
---
+## Forms
+
+### Adding
+Consider the flow of adding a new issue as a defining example.
+Suppose you are viewing a list of issues.
+
+There should be an affordance (a button for example) that is labeled `Add` or `Add Issue`.
+(Refer to verbs below.)
+Clicking the button should bring you to a form.
+
+The form should be titled `Add` or `Add Issue`.
+
+The submit button should be labeled `Save`. Do not use `Add`, `Create`, `New`, or `Save Changes`.
+
+The cancel button should be labeled `Cancel`. Do not use `Back`.
+
+### Editing
+Consider the flow of editing an existing issue as a defining example.
+Suppose you are viewing an issue.
+
+There should be an affordance (a button for example) that is labeled `Edit` or `Edit issue`.
+Clicking the button should bring you to a form.
+
+The form should be titled `Edit` or `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`.
+
+
+---
+
## Issues
### Adjectives (states)
@@ -30,14 +63,14 @@ An existing issue can be either `open` or `closed`. Only use these two adjacetiv
For example, use `5 open issues` and do not use `5 pending issues`.
### Verbs (actions)
-For creating of an issue that does not exist, only use `add`. Do not use `create`, `new`.
+For adding of an issue that does not exist, only use `add`. Do not use `create` or `new`.
For viewing an issue, only use `view`.
-For updating an issue, only use `edit`. Do not use `update`.
+For editing an issue, only use `edit`. Do not use `update`.
For closing an open issue, only use `close`.
For re-opening a closed issue, only use `re-open`. There should never be a need to use `open` as a verb.
-For deleting an issue, only use `remove`. Do not use `delete`.
+For removing an issue, only use `remove`. Do not use `delete`.