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: docs/style-guide/style-conventions.md
+24-18Lines changed: 24 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ We prioritize simplicity over comprehensiveness. If you can't find a particular
57
57
58
58
## Titles
59
59
60
-
- Use the rules described in the [Structuring the content](structuring-the-content.md) section for each [type of document](./structuring-the-content.md#types-of-documents) (concept, procedure, reference, or guide).
60
+
- Use the rules described in the [Structuring the content](structuring-the-content.md) section for each [document type](./structuring-the-content.md#types-of-documents) (concept, procedure, reference, or guide).
61
61
- Use meaningful titles that provide a precise idea of the article's content.
62
62
63
63
| Usage | Example |
@@ -70,16 +70,21 @@ We prioritize simplicity over comprehensiveness. If you can't find a particular
70
70
| Incorrect | Browsing people and Communities |
71
71
72
72
- Adhere to the [capitalization](#capitalization) convention described in this article.
73
-
- Use the title of the article in lowercase letters for the Markdown file name. Use a dash symbol ("-") to replace spaces. Don't exclude articles, prepositions, or any other word in the Markdown file name.
73
+
- Your article's title determines the Markdown file name:
74
+
- Use the article's title in all-lowercase letters for the Markdown file name.
75
+
- Use a dash symbol ("-") to replace spaces.
76
+
- Don't exclude articles, prepositions, or any other word in the Markdown file name.
77
+
- If the name includes apostrophes, remove them from the Markdown file name.
@@ -91,8 +96,8 @@ We prioritize simplicity over comprehensiveness. If you can't find a particular
91
96
92
97
## Sentences and paragraphs
93
98
94
-
- Write sentences of a maximum of 25 words and paragraphs with a maximum of 5 lines. Rewrite the content and break sentences and paragraphs if necessary.
95
-
- Include *the* and *that* to clarify your sentence:
99
+
- Write sentences of a maximum of 25 words and paragraphs of 5 lines. Rewrite the content and break sentences and paragraphs as necessary.
100
+
- Include *the* and *that* to clarify your sentence.
@@ -151,19 +156,19 @@ We prioritize simplicity over comprehensiveness. If you can't find a particular
151
156
- Use a bullet list to improve the readability of sentences or paragraphs where you list or describe three or more items.
152
157
153
158
| Usage | Example |
154
-
|:--|:--|
159
+
|:---|:---|
155
160
|**Correct**| You can find four different types of contacts in your contact list:</br>- Trusted</br>- Verified</br>- Pending verification</br>- Blocked |
156
161
| Incorrect | You can find four different types of contacts in your contact lists: trusted, verified, pending verification, and blocked. |
157
162
| Incorrect | You can find trusted, verified, pending verification, and blocked contacts on your contact list. |
158
163
159
164
- Use a colon (:) before the bullet list items.
160
-
-For [punctuation](#punctuation), use periods at the end of each sentence in a bullet list.
165
+
-Use periods at the end of each sentence in a bullet list for [punctuation](#punctuation).
161
166
- Punctuation on a bullet list can be tricky. Use the following guidelines:
162
167
- When the list items are complete sentences, use a period at the end of each sentence.
163
168
- Don't use a period when the list items are not complete sentences or sentences with three words or less.
164
169
- In a list with elements of more and less than three words mixed, don't use a period.
165
170
- When you need to describe each element on a list, consider [using a table](#tables) instead.
166
-
- Don't use a bullet list for actions that users should complete orderly, use a [numbered list](#numbered-lists) in a [procedure](./structuring-the-content.md#procedure-help-me-to-do).
171
+
- Don't use a bullet list for actions that users should complete in an orderly manner; use a [numbered list](#numbered-lists) in a [procedure](./structuring-the-content.md#procedure-help-me-to-do).
167
172
168
173
## Numbered lists
169
174
@@ -218,7 +223,7 @@ Remember that users may access the information using a smartphone. Therefore, if
218
223
| Incorrect | 0,13 |
219
224
| Incorrect | 0'13 |
220
225
221
-
- Don't use thousand separators. While a thousand separator improves readability (especially for very long numbers), their symbol and placement vary among countries.
226
+
- Don't use the thousand separator. While the separator improves readability (especially for very long numbers), their symbol and placement vary among countries.
222
227
223
228
| Usage | Example |
224
229
|:------------|:--------|
@@ -254,7 +259,7 @@ Remember that users may access the information using a smartphone. Therefore, if
254
259
| Incorrect | 1pm |
255
260
| Incorrect | 1 PM |
256
261
|**Correct**| 8:30 p.m. |
257
-
| Incorrect | half past eight p.m.|
262
+
| Incorrect | half past eight |
258
263
259
264
- Use the [UTC time standard :octicons-tab-external-16:](https://en.wikipedia.org/wiki/Coordinated_Universal_Time){:target="_blank"} when writing for a global audience.
260
265
@@ -287,7 +292,7 @@ Use links to other articles in the Status documentation, but don't abuse links.
287
292
| Incorrect | Check the "Safely open apps on your Mac" article at [https://support.apple.com/en-us/HT202491](https://support.apple.com/en-us/HT202491). |
288
293
| Incorrect | Check [https://support.apple.com/en-us/HT202491](https://support.apple.com/en-us/HT202491) on the Apple Support website. |
289
294
290
-
- For external links, add the `{:target="_blank"}` at the end of the URL to open the link in a new broser tab. Example:
295
+
- For external links, add the `{:target="_blank"}` at the end of the URL to open the link in a new browser tab. Example:
291
296
292
297
For the Mac version, use the `[Status website :octicons-tab-external-16:](https://status.im/get){:target="_blank"}`
293
298
@@ -299,7 +304,7 @@ Use links to other articles in the Status documentation, but don't abuse links.
299
304
!!! info
300
305
For readability reasons, the examples in other sections don't use these UI elements conventions.
301
306
302
-
- UI elements are screen components the user can interact with. A checkbox, a menu, or a button are all UI elements. An explanatory text with no user interaction is not considered a UI element for the purpose of this guide.
307
+
- UI elements are screen components the user can interact with. A checkbox, a menu, or a button are all UI elements. An explanatory text with no user interaction is not considered a UI element in the context of this guide.
303
308
- Write the UI element as seen on the screen, even if it contradicts the style conventions in this guide.
304
309
- Use a bold typeface to write UI elements in procedural steps (1, 2, 3, and so on.) Don't use the bold typeface outside of the procedural steps.
305
310
@@ -351,15 +356,15 @@ Use links to other articles in the Status documentation, but don't abuse links.
351
356
|**Correct**| Go to **Settings** > **Messages** > **Privacy**. |
352
357
| Incorrect | Go to **Settings**, then go to **Messages**, then tap **Privacy**. |
353
358
354
-
## Admonitions (callouts)
359
+
## Admonitions
355
360
356
-
- Status documentation uses three different types of admonitions or callouts:
361
+
- Status user documentation uses three different types of admonitions (also known as *callouts*):
357
362
358
363
| Admonition | Description |
359
-
|---|---|
360
-
| Tip | Information that is not necessary for the task, but it's nice to have. For example, information about a keyboard shortcut. |
361
-
| Info | Information that is useful to complete the task. This information has no impact on the user's task. |
362
-
| Caution | Information that has an impact on the user's task. Based on this information, the user may decide to complete or don't complete the task. |
364
+
|:---|:---|
365
+
| Tip | Information that is not necessary for the task, but it's helpful and nice to have. For example, information about a keyboard shortcut. |
366
+
| Info | Information that is relevant to complete the task, but has no impact on the user's actions. |
367
+
| Caution | Information that has an impact on the user's actions. Based on this information, the user may decide to complete or don't complete the task. |
363
368
364
369
- Don't use *warning*, *error*, *danger*, *bug*, *important*, or *notes*.
365
370
- Don't use admonitions within procedural steps.
@@ -446,6 +451,7 @@ Modal verbs are auxiliary verbs that modify the meaning of the main verb in a se
446
451
- Observe the [style rules for numbers, date and time, and units of measure](#numbers-date-and-time-currencies-and-units-of-measure).
447
452
- Avoid using *they* to refer to the neutral gender. While this is a perfectly valid rule in English, it may be challenging to interpret by non-native English speakers.
448
453
- Use left and right carefully. Localized products in left-to-right (LTR) languages may have labels on the opposite side. Refer the reader to the specific UI element on the screen instead.
454
+
- Don't use pronouns like *Who*, *Whose*, or *Its*; replace the pronoun with the noun.
0 commit comments