Skip to content

Commit 20be492

Browse files
committed
docs(design): address review feedback on UX writing guide
- Add Nextcloud naming rule (capital N, lowercase c, no NextCloud/Nc) - Add "never all uppercase" to sentence case rule with SHARE example - Add names, pronouns, and gender section (full names, avoid my/your, gender-neutral language with link to international guide) - Move destructive actions note above the button labels table Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
1 parent e1dfad2 commit 20be492

1 file changed

Lines changed: 36 additions & 2 deletions

File tree

developer_manual/design/writing.rst

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ General rules
1212

1313
**Keep messages short.** One idea per sentence. Cut every word that does not add meaning.
1414

15+
**Write Nextcloud correctly.** Always spell it ``Nextcloud`` — capital N, lowercase c.
16+
Do not write ``NextCloud``, ``nextcloud``, or abbreviate it as ``Nc``.
17+
1518
**Use sentence case.** Capitalize only the first word and proper nouns.
19+
Never use all uppercase for headings, labels, or tags.
1620

1721
.. list-table::
1822
:header-rows: 1
@@ -26,6 +30,10 @@ General rules
2630
- Could not load the file
2731
* - Your changes have been successfully applied to the system
2832
- Changes saved
33+
* - SHARE
34+
- Share
35+
* - NextCloud
36+
- Nextcloud
2937

3038
**Drop "successfully".** If an action completed, the result speaks for itself.
3139
State what happened, not that it happened without error.
@@ -77,10 +85,36 @@ Tone
7785
* - Oops! Something went wrong!
7886
- Could not complete the request
7987

88+
Names, pronouns, and gender
89+
---------------------------
90+
91+
**Use full names** when addressing users. A full name is less ambiguous and more respectful than a first name alone.
92+
93+
**Avoid possessive pronouns** where possible. Replace ``my`` and ``your`` with a more descriptive word.
94+
Where a pronoun cannot be avoided, prefer ``your`` over ``my``.
95+
96+
**Use gender-neutral language.** Refer to people with ``they``/``them`` rather than ``he``/``she``
97+
when gender is unknown. For additional guidance and language-specific examples, see the
98+
`International guide to gender-inclusive writing <https://uxcontent.com/the-international-guide-to-gender-inclusive-writing/>`_.
99+
100+
.. list-table::
101+
:header-rows: 1
102+
:widths: 50 50
103+
104+
* - Avoid
105+
- Prefer
106+
* - Hello, Christine
107+
- Hello, Christine Schott
108+
* - My files
109+
- Personal files
110+
* - Alex raised his hand
111+
- Alex raised their hand
112+
80113
Button and action labels
81114
------------------------
82115

83116
Use **verb + noun** for buttons that trigger an action. The noun can be omitted when context makes it obvious.
117+
For destructive actions use the specific verb so users know exactly what will happen: **Delete**, **Remove**, **Revoke** — not **Confirm** or **OK**.
84118

85119
.. list-table::
86120
:header-rows: 1
@@ -94,8 +128,8 @@ Use **verb + noun** for buttons that trigger an action. The noun can be omitted
94128
- Create account
95129
* - Yes
96130
- Delete file
97-
98-
For destructive actions use the specific verb so users know exactly what will happen: **Delete**, **Remove**, **Revoke** — not **Confirm** or **OK**.
131+
* - Confirm
132+
- Delete file
99133

100134
Placeholders and variables
101135
--------------------------

0 commit comments

Comments
 (0)