5.3 KiB
id, revision, hide
| id | revision | hide | |
|---|---|---|---|
| 20 | 3 |
|
Terminology
Word choice
Write in Global and Plain English.
- Don't use words that can be confusing for non-native speakers. For more details, see the [A-Z of alternative words :octicons-tab-external-16:][plain-english-alternative-words]{:target="_blank"} composed by the Plain English Campaign.
- Don't use Latin abbreviations like e.g., etc. or i.e. Use an English equivalent, like for example, and so on, or that is.
- This table summarizes some common words and terms.
| Don't use | Use |
|---|---|
| cannot | can't |
| ensure | make sure |
| have to | must (see Modal verbs) |
| in order to | to |
| in a way | so |
| need to | Imperative form of verb (or should) |
| drag-and-drop | drag and drop |
| Who, Whose | Replace the pronoun with the noun |
| & | and |
| time stamp | timestamp |
| web site | website |
| application | app |
| check box | checkbox |
| run (an app) | launch (an app) |
| cryptocurrency | crypto |
| Defi | DeFi |
| Dapp, dApp | DApp |
| MacOS | macOS |
| Macintosh | Mac |
| GNU Linux | Linux |
| Apple Silicon | Apple silicon |
| Intel (processor) | Intel processor |
| Web3, Web3.0, web3.0 | web3 |
| DApp or dapp | dApp |
| avatar | profile picture |
Status products and features names
Products and names include:
- Status apps features (for example, Status Communities).
- Products and services that are part of the Status Network :octicons-tab-external-16:{:target="_blank"} (for example, Keycard).
- Status apps features or proper nouns (like the Activity Center).
!!! note Observe the capitalization convention. For example, use Activity Center and not activity center.
| Product/UI name | Notes |
|---|---|
| Status Communities | Include Status the first time you write about Communities in the body text. |
| Activity Center | UI area where users can review and respond to activity notifications (:desktop-notification:) |
| profile picture | Clickable UI element with the user's picture |
| formatting toolbar | Toolbar showing the text formatting options |
Status user interface names
These sections describe how to name the different user interface areas in Status Help documentation.
!!! note To write UI areas or sidebars, use a bold typeface only for the visible part in the UI. Check the format guidelines in UI elements for more information.
Status Mobile user interface areas
This picture describes the main user interface areas for Status Mobile.
| Area | Name convention |
|---|---|
| A | top navigation |
| B | information card |
| C | [content] list, where [content] depends on the list of elements. For example, Contacts list, Communities list, and so on. |
| D | action sheet, when the list of actions comes from the Status app / share sheet, when the list of actions comes from the operating system. |
| E | tab bar |
| F | tabs |
Status Desktop and Status Web user interface areas
This picture describes the main user interface areas for Status Web and Status Desktop apps.
| Area | Name convention |
|---|---|
| A | navigation sidebar |
| B | [content] sidebar, where [content] depends on the element the user selects in the navigation bar. For example, when the user clicks the Settings option in the navigation bar, this area is the Settings sidebar. When the user clicks the Community option, this is the Community sidebar. And so on. |
| C | content area |
| D | right sidebar |
| E | channel information at the top of the content area |
| F | pinned messages area |
Icon names
If the icon shows a label in the UI, use the UI label. If the icon doesn't show a label in the UI, use the a name based on the icon's Figma description.
[:octicons-git-branch-24: Contribute to our docs][contributors-guide]{ .md-button }
--8<-- "includes/urls-style-guide.txt"