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
+26-7Lines changed: 26 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
id: 12
3
-
revision: 6
3
+
revision: 7
4
4
hide:
5
5
- navigation
6
6
---
@@ -37,7 +37,7 @@ We prioritize simplicity over comprehensiveness. If you can't find a particular
37
37
38
38
## Capitalization
39
39
40
-
- Use sentence-style capitalization, including [titles](#titles). That means everything is lowercase except the first word, proper nouns, like the [Status product names](#product-and-user-interface-names).
40
+
- Use sentence-style capitalization, including [titles](#titles). That means everything is lowercase except the first word, proper nouns, like the [Status product names](#product-names-and-user-interface-areas).
@@ -372,8 +372,9 @@ When you describe a UI interaction, use these action verbs:
372
372
|:---|:---|
373
373
| Go to a menu or screen | Use *go to*. |
374
374
| Click a URL | For URLs, the verb depends on the user's intent:</br>- To complete another action (for example, to download something), use *visit*.</br>- To review the information on a different article or website, use *check*. |
375
-
| Click a single UI element |*click* (desktop and web) or *tap* (mobile). |
376
-
| Click multiple UI elements |*choose* for desktop, web, and mobile. |
375
+
| Select a single UI element |*click* (desktop and web) or *tap* (mobile). |
376
+
| Select multiple UI elements |*choose* for desktop, web, and mobile. |
377
+
| Select text |*select*|
377
378
| Acion on checkboxes |*check* the [UI label] box (to enable) / *uncheck* the [UI label] box (to disable). |
378
379
| Go to previous screen | Use *return*. |
379
380
| Swipe element | Use *swipe*[left or right] for desktop, web, and mobile. |
@@ -401,14 +402,23 @@ The Status documentation uses the application icons to guide readers' actions on
401
402
402
403
- Use icons in procedural steps to guide the user's actions.
403
404
- Don't overuse icons. A document with many icons is harder to follow and scan.
404
-
- Write the icon first, and then the icon's label. If the icon doesn't show a label in the UI, use the icon's name (or any other name that represents the icon's function) and add this to the [Products and user interface names](#product-and-user-interface-names)list.
405
+
- Write the icon first, and then the icon's name. If the icon doesn't show a label in the UI, use the icon's name in the the [Icons names](#icon-names)reference table.
405
406
- Use the Status icons on the `/override/.icons/status` folder in the GitHub [user documentation repository :octicons-tab-external-16:][status-github-user-doc-repo]{:target="_blank"}.
406
407
- To reference these icons anywhere on the Markdown file, use the `:icon-name:` notation right before the icon's name. For example, the Status wallet icon under the `.icons` directory is `status-wallet.svg`; to show this icon in a sentence, use:
407
408
408
409
```text
409
410
Tap :status-wallet: Wallet and save your settings.
410
411
```
411
412
413
+
## Symbols and punctuation marks
414
+
415
+
To spell out symbols and punctuations marks, use the [List of typographical symbols and punctuation marks :octicons-tab-external-16:][wikipedia-symbols-and-marks]{:target="_blank"} article from Wikipedia.
| **Correct** | To quote text inline, use the greater-than sign (`>`) before your text. |
420
+
| Incorrect | To quote text inline, use the bigger-than sign (`>`) before your text. |
421
+
412
422
## Modal verbs
413
423
414
424
Modal verbs are auxiliary verbs that modify the meaning of the main verb in a sentence. Modal verbs can be problematic in technical communication:
@@ -552,9 +562,9 @@ Modal verbs are auxiliary verbs that modify the meaning of the main verb in a se
552
562
| Apple Silicon | Apple silicon |
553
563
| Intel (processor) | Intel processor |
554
564
555
-
## Product names and user interface areas
565
+
## Naming products, user interface areas, and icons
556
566
557
-
Product and user interface names include:
567
+
Products and user interface areas names include:
558
568
559
569
- Status apps features (for example, Status Communities).
560
570
- Products and services that are part of the [Status Network :octicons-tab-external-16:](https://statusnetwork.com/){:target="_blank"} (for example, Keycard).
@@ -563,11 +573,14 @@ Product and user interface names include:
563
573
!!! info
564
574
Observe the capitalization convention. For example, use *Activity Center* and not *activity center*.
565
575
576
+
### Products and user interface areas reference
577
+
566
578
| Product/UI name | Notes |
567
579
|:---|:---|
568
580
| Status Communities | Include *Status* the first time you write about Communities in the body text. |
569
581
| Activity Center | UI area where users can review and respond to activity notifications (:status-notification:) |
570
582
| profile picture | Clickable UI element with the user's picture |
583
+
| formatting toolbar | Toolbar showing the text formatting options |
571
584
572
585
### Status Desktop and Status Web main UI areas
573
586
@@ -588,6 +601,12 @@ This picture describes the main user interface areas for Status Web and Status D
588
601
| E | channel information at the top of the content area |
589
602
| F | pinned messages area |
590
603
604
+
### Icon names
605
+
606
+
| Name | Icon |
607
+
|:--------|:--------------------|
608
+
| members | :status-group-chat: |
609
+
591
610
<br>[:octicons-git-branch-24: Contribute to our docs][contributors-guide]{ .md-button }</br>
0 commit comments