You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: general/contentguidelines/01-productwriting/contentprinciples.md
+41-59Lines changed: 41 additions & 59 deletions
Original file line number
Diff line number
Diff line change
@@ -6,33 +6,49 @@ tags:
6
6
- UX Writing
7
7
---
8
8
9
-
Our content principles help us understand and reinforce our personality, tone and voice. They also help us provide a consistent experience across all our products, services output and any other way we interact with people.
9
+
## Our vision
10
10
11
-
With everything we write, we aim to:
11
+
We design content experiences that support educators and learners in focusing on what matters most: teaching and learning. We make Moodle feel clear, human, and easy to use, no matter who you are, where you're from, or what you're trying to do.
12
12
13
-
**Empower** our users to achieve their goals.<br/>
14
-
**Guide** them to make the most out of our products and services.<br/>
15
-
**Educate** them by giving them the exact information they need, plus opportunities to learn more.<br/>
16
-
**Respect** our users, their sensitivity, and time by showing integrity and not patronising them.
13
+
We do this by:
17
14
18
-
To achieve this, we follow these principles:
15
+
- Making complex functionality feel intuitive and human
16
+
- Designing with accessibility and internationalisation at the core
17
+
- Bringing clarity, consistency, and care to every interaction
18
+
- Embedding content design into product decisions and design
19
+
20
+
## Our goal
21
+
22
+
Our content helps users feel confident, supported, and respected. With everything we write, we aim to:
23
+
24
+
-**Empower** our users to achieve their goals<br/>
25
+
-**Guide** them to get the most from our products and services<br/>
26
+
-**Support** their understanding with just the right information without overwhelming them, plus clear paths to learn more<br/>
27
+
-**Respect** their time, attention, and differences, through integrity, clarity, and care
28
+
29
+
## Our content principles:
30
+
31
+
These principles guide every content decision we make. They help us stay consistent, accessible, and aligned across products, services, and all user interactions.
19
32
20
33
### Keep it simple
21
34
22
-
We write in English for a global audience, and want to make our content accessible to everyone.
35
+
We write in plain English for a global audience. Our goal is to make Moodle accessible to everyone.
23
36
24
-
- Use short sentences and everyday words that our users understand and use.
25
-
-Keep your words direct and to the point.
26
-
- Avoid jargon and idioms that may be difficult to understand with no context.
27
-
- Make instructions clear, actionable and concise.
37
+
- Use short sentences and everyday words that our users understand and use
38
+
-Get straight to the point
39
+
- Avoid jargon, idioms, and culture-specific references
40
+
- Make instructions clear, actionable, and concise
28
41
29
42
### Be relevant
30
43
31
-
Communicate the correct details for a specific situation and no more. Get rid of complicated words and excess information. When we help users focus on the task at hand, they feel safe and empowered.
44
+
We give users the information they need to perform their task and make informed decisions: no more, no less. When users get the right details at the right time, they can stay focused, feel confident, and move forward smoothly.
45
+
46
+
### Be positive and supportive
32
47
33
-
### Be positive
48
+
Use language that helps users move forward. Be constructive and encouraging, especially when guiding users through difficult moments.
34
49
35
-
Tell people what they can or should do instead of what they can't or shouldn't do. If you see lots of 'can't' or 'don't', you may be using negative language.
50
+
- Tell people what they *can* or *should* do
51
+
- Reframe errors and restrictions as helpful guidance
36
52
37
53
<ValidExampletitle="Do">
38
54
@@ -48,7 +64,7 @@ You can't complete this section until you submit your final assignment.
48
64
49
65
### Use active voice
50
66
51
-
Active voice eliminates ambiguity.
67
+
Active voice is clearer and easier to follow.
52
68
53
69
<ValidExampletitle="Do">
54
70
@@ -62,51 +78,17 @@ A deadline can be set by teachers.
62
78
63
79
</InvalidExample>
64
80
65
-
### Limit your exclamation points
66
-
67
-
*When everything is exciting, nothing is exciting*. We save exclamation points for key moments in the user journey; for example when we welcome them on board one of our products for the first time.
68
-
69
-
### Spell out acronyms the first time you use them
70
-
71
-
Example: Branded Moodle App (BMA)
72
-
73
-
### Use sentence case
74
-
75
-
Use capital letters only at the beginning of sentences and for proper nouns. For headings, subheadings and calls to action, we use sentence case and not Title Case.
76
-
77
-
<ValidExampletitle="Do">
78
-
79
-
Read the full article.
80
-
81
-
</ValidExample>
82
-
83
-
<InvalidExampletitle="Don't">
84
-
85
-
Read the Full Article.
86
-
87
-
</InvalidExample>
88
-
89
-
### Follow the rules of UK/Australian English
90
-
91
-
Although we have global headquarters, we default to UK/Australian spelling. (Except for communications from Moodle US, which use American spelling to suit their market.)
92
-
93
-
### Avoid regionally specific date formats
94
-
95
-
Don't use 13/02/2022 or 02/13/2022. To avoid confusion, write the date as 13 February 2022.
96
-
97
-
### Words and phrases to avoid
98
-
99
-
We write with accessibility, inclusivity and diversity in mind. That's why we avoid:
81
+
### Write for inclusion
100
82
101
-
- Language that reinforces racial, ethnic or religious stereotypes, for example: Use *allowlist* and *denylist* instead of *whitelist* and *blacklist*.
102
-
- Ableist language, for example: Say *amazing*, *awesome*, *shocking* or *intense* instead of *insane* or *crazy*. Say *final check* instead of *sanity check*.
103
-
- Unnecessarily gendered words, for example: Say *people* or *humanity* instead of *mankind*. Say *chairperson* or *chair* instead of *chairman*.
104
-
- Figures of speech that refer to war or violence, for example: Say *try* instead of *take a shot*. Say *near miss* instead of *dodged bullet*
83
+
We write with accessibility, diversity, and respect in mind.
105
84
106
-
### Use diverse examples
85
+
- Avoid stereotypes, ableist language, and unnecessary gendering. For example, use *final check* instead of *sanity check*, *allowlist* instead of *whitelist*, or *chairperson* instead of *chairman*
86
+
- Choose examples that reflect different cultures, names, and ages
87
+
- Avoid metaphors tied to violence
107
88
108
-
If you're inventing people or situations, choose different genders and ages. Don't stick to English names.
89
+
### Work together
109
90
110
-
### Ask for a quick review
91
+
Good content design is a team effort. We share early, welcome feedback, and learn from each other.
111
92
112
-
If English is not your first language and you feel unsure about the clarity of something you're writing, reach out to a native English speaking team member for support.
93
+
- If you're unsure, especially if English is not your first language, ask a teammate to review your work
94
+
- We support one another in writing clearly and inclusively
0 commit comments