write.status.im/docs/style-conventions.md

id, revision, hide

id	revision	hide
12	11	navigation

Style conventions

This article describes the most common style elements and conventions in the Status user documentation. The goal is to simplify the writer's workflow using unambiguous guidelines that are easy to remember and follow.

You can find correct and incorrect use examples in most of these style conventions. In many cases, the incorrect examples are valid and commonly used sentences in English. They're incorrect only in the context of this style guide and the Status technical documentation.

We prioritize simplicity over comprehensiveness. If you can't find a particular style convention, use the [Microsoft Style Guide :octicons-tab-external-16:][microsoft-style-guide]{:target="_blank"}. If you think a style convention is missing, you can [contribute :octicons-tab-external-16:][contributors-guide] to this topic.

Writing style

!!! tip For general writing style guidelines, check out the Writing style section.

• Address the user using you or your.

• Use the active voice to emphasize that the action is on the user, not the software. Sometimes a passive sentence is unavoidable, and that's OK.

  Usage	Example
  Correct	Click Block User to block messages from the user.
  Incorrect	The Block User option must be selected to block messages from the user.

• Write in the present tense. Avoid using the future tense or variations of the present tense, such as the present perfect tense.

  Usage	Example
  Correct	If you tap Untrust, you should complete a mutual verification again.
  Incorrect	If you tap Untrust, you will need to complete a mutual verification again.
  Correct	You can see the new badge after you complete the mutual verification.
  Incorrect	You will see the new badge once you have completed the mutual verification.

Capitalization

• Use sentence-style capitalization, including titles. That means everything is lowercase except the first word, proper nouns, like the Status product names.

  Usage	Example
  Correct	Configure your Status Community permissions
  Incorrect	Configure Your Status Community Permissions
  Incorrect	Configure Your Status community Permissions

• Don't capitalize words after colons, except when these words are proper nouns, acronyms, or bullet list items.

  Usage	Example
  Correct	Members should complete two steps: agree to the community terms and verify their identity.
  Incorrect	Members should complete two steps: Agree to the community terms and verify their identity.
  Correct	Members should complete two steps: - Agree to the community terms. - Verify their identity.
  Incorrect	Members should complete two steps: - agree to the community terms. - verify their identity.
  Correct	Many digital currencies use the ERC-20 standard: Status (STN), Basic Attention Token (BAT), MakerDAO (DAI), and others.

Titles

• Use the rules described in the Structuring the content section for each document type (concept, procedure, reference, or guide).

• Use meaningful titles that provide a precise idea of the article's content.

  Usage	Example
  Correct	Remove someone from a Community channel
  Incorrect	Remove someone
  Incorrect	Removing someone from a Community
  Correct	Browse people and Communities in Status
  Incorrect	Browsing people
  Incorrect	Browsing people and Communities

• Adhere to the capitalization convention described in this article.

• Your article's title determines the Markdown file name:

  • Use the article's title in all-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.
  • If the name includes apostrophes, remove them from the Markdown file name. If the apostrophe is part of the possesive form with an extra s letter, separate the letter in the name (example: transfer-you-community-s-ownership).

  Usage	Article name	Markdown file name
  Correct	Browse people and Communities in Status	browse-people-and-communities-in-status.md
  Correct	Transfer your community's ownership	transfer-your-community-s-ownership
  Incorrect	Trasnfer your community's ownership	transfer-your-communitys-ownership
  Incorrect	Browse people and Communities in Status	Browse-people-and-Communities-in-Status.md
  Incorrect	Browse people and Communities in Status	browse-people-communities-status.md
  Correct	FAQ: Import data from Discord	faq-import-data-from-discord.md
  Correct	Do's and don'ts of Profile security	dos-and-donts-of-profile-security.md

• At the index page level, use a bold typeface to stress the action and the feature or concept in the document.

  Usage	Example
  Correct	Add new members to your Community
  Incorrect	Add new members to your Community
  Incorrect	Add new members to your Community
  Correct	About your crypto wallet seed phrase
  Incorrect	About your crypto wallet seed phrase

Sentences and paragraphs

• Write sentences of a maximum of 25 words and paragraphs of no more than 50-60 words. Rewrite the content and break sentences and paragraphs as necessary.

• Include the and that to clarify your sentence.

  Usage	Example
  Correct	Identify the chart settings that affect the layout.
  Incorrect	Identify chart settings affecting the layout.
  Correct	The database that is online syncs every 30 seconds.
  Incorrect	The online database syncs every 30 seconds.

• Don't use sentence connectors: So, Thus, Therefore, Consequently, As a consequence, For this reason, Hence, and so on.

  Usage	Example
  Correct	Your seed phrase provides access to your crypto assets. Keep your seed phrase safe.
  Incorrect	Your seed phrase provides access to your crypto assets. Therefore, keep your seed phrase safe.

• Avoid long [noun phrases :octicons-tab-external-16:][wikipedia-noun-phrases]{:target="_blank"}. Don't use more than one modifier if you use a noun phrase. Use the of preposition to simplify noun phrases.

  Usage	Example
  Correct	The default lifetime of a token value is one year.
  Incorrect	The default token value lifetime is one year.

• Keep adjectives and adverbs immediately before the word they're modifying. Pay close attention to only and not.

  Usage	Example
  Correct	You can access your messages only after 30 days.
  Incorrect	You can only access your messages after 30 days.

• In the first paragraph after a heading, avoid repeating the title information. For example, if the heading title is "Search for a contact using the Status display name," don't start the first paragraph with "To search for a contact using the Status display name [...]"

• Lookup for instances of the which word on your text; it's possible you can replace them with that. For more information about the differences between which and that, check this [Grammarly :octicons-tab-external-16:][grammarly-which-vs-that]{:target="_blank"} article.

Punctuation

• Avoid. Unnecessary. Punctuation.
• Use these guidelines for commas:
  • Use commas to separate main clauses.
  • Use a comma before such as.
  • Use a comma after for example.
  • Use the Oxford comma for and and or conjunctions where the meaning of your sentence would otherwise be unclear. In other cases, avoid placing the extra comma.
  • In procedural steps, don't write a comma in sentences such as click on cancel, and then...
• Use these guidelines for periods:
  • Use a period at the end of a sentence, including sentences ending on a URL.
  • Observe the punctuation rules for items on a bullet list.
• Don't use semicolons. Instead, use a period and write the text after the semicolon in a new sentence.
• Avoid preceding tables with colons. Instead, use a period.
• Don't use dashes (em or en dashes.) Instead, use parenthesis if you need to clarify information.
• Use parenthesis sparingly, and don't write essential information inside parenthesis.
• Don't use bold or italics with punctuation symbols.
• When you must use quotes, use double straight quotes. Don't use quotes with user interface elements.
• Observe the bullet lists punctuation rules.

Bullet lists

• Don't use a bullet list for actions that users should complete in an orderly manner; use a numbered list in a procedure.

• Use a bullet list to improve the readability of sentences or paragraphs where you list or describe three or more items.

  Usage	Example
  Correct	You can find four different types of contacts in your contact list: - Trusted - Verified - Pending verification - Blocked
  Incorrect	You can find four different types of contacts in your contact lists: trusted, verified, pending verification, and blocked.
  Incorrect	You can find trusted, verified, pending verification, and blocked contacts on your contact list.

• Use a colon (:) before the bullet list items.

• Use periods at the end of each sentence in a bullet list for punctuation. Using periods on a bullet list can be tricky. Use the following guidelines:

  • When the list items are complete sentences, use a period at the end of each sentence.
  • Don't use a period when the list items are not complete sentences or sentences with three words or less.
  • In a list with elements of more and less than three words mixed, don't use a period.

• Don't use colons after each item on a list; type the item definition on a new line. Here are some examples of using punctuation on a list:

  Usage	Example
  Correct	- Blue badge The user is a verified contact and you completed mutual authentication successfully. - Red badge The user is not a verified contact.
  Incorrect	- Blue badge: The user is a verified contact and you completed mutual authentication successfully. - Red badge: The user is not a verified contact.
  Incorrect	- Blue badge: The user is a verified contact and you completed mutual authentication successfully. - Red badge: The user is not a verified contact.
  Incorrect	- Blue badge - The user is a verified contact and you completed mutual authentication successfully. - Red badge - The user is not a verified contact.

  !!! tip When you need to describe each element on a list and you have more than three elements, consider using a table instead.

Numbered lists

When reading instructions, users understand numbered lists as actions to complete orderly. Because of this, limit the numbered lists to procedural instructions in procedure-type topics.

If you must use a numbered list outside of a procedure, use the same rules described for bullet lists.

Tables

Tables provide a simple way to summarize information. Use a table instead of bullet lists when you must describe the elements in the list.

• Bullet list example (incorrect):

  There are four types of items:

  • Item 1
    Item 1 description
  • Item 2
    Item 2 description
  • Item 3
    Item 3 description
  • Item 4
    Item 4 description

• Table format example (correct):

  There are four types of items:

  Item	Description
  Item 1	Item 1 description
  Item 2	Item 2 description
  Item 3	Item 3 description
  Item 4	Item 4 description

You can also use tables to compare the available options across different elements. For example, you may want to compare the available features in the Status apps (desktop, mobile, and web) using a table like this one:

Features	Desktop	Mobile	Web
Feature A	:octicons-check-16:	:octicons-check-16:
Feature B	:octicons-check-16:
Feature C		:octicons-check-16:	:octicons-check-16:
Feature D			:octicons-check-16:

Remember that users may access the information using a smartphone. Therefore, if your table contains a lot of information or more than three or four columns, consider organizing it differently or using more than one table.

!!! tip You can use links in tables except if the table is part of a procedure step.

Numbers, date and time, currencies, and units of measure

• In body text, spell out whole numbers from zero through nine and use numerals for 10 or greater.

• For decimals, begin with a zero and use the dot (.) as the decimal point. Don't spell out decimals.

  Usage	Example
  Correct	20.23
  Correct	0.13
  Incorrect	0,13
  Incorrect	0'13

• When writing in English, use a comma (,) as the thousand separator and a colon (.) as the decimal separator to improve readability. For languages other than English, use the commonly accepted rule in the country or a comma if a common practice is unknown or controversial.

  !!! note There isn't a common notation for thousand and decimal separators and notation varies among different countries. In the United States, the decimal separator is a period (.) and the thousands separator is a comma (,). In Germany, the decimal separator is a comma (,) and the thousands separator is a period (.). In Sweden, the thousands separator is a space.

  Usage	Example
  Correct	2,500
  Incorrect	2500
  Correct	12,500
  Incorrect	12.500
  Correct	2,500.46
  Incorrect	2.500,46
  Correct	118,000
  Incorrect	118 000
  Correct	118,000,000
  Incorrect	118'000'000

• Don't use rd. or th. to express dates or indicate the order of things.

  Usage	Example
  Correct	Choose the options in rows 3 and 5.
  Incorrect	Choose the 3rd. and 5th. options.

• Different countries use different ways of writing days as numerals. Write out the date to avoid confusion.

  Usage	Example
  Correct	The latest version was released on May 6, 2023.
  Incorrect	The latest version was released on 05/06/23.
  Incorrect	The latest version was released on the 6th. of May, 2023

• For writing decades, use two-digit numbers with an apostrophe (') before and the s letter after the number (for example, '90s).

• To describe a time, use the 12-hour clock with lowercase a.m./p.m. notation after the time. Don't write out the time.

  Usage	Example
  Correct	1 p.m.
  Incorrect	13 h.
  Incorrect	1pm
  Incorrect	1 PM
  Correct	8:30 p.m.
  Incorrect	half past eight

• Use the UTC time standard :octicons-tab-external-16:{:target="_blank"} when writing for a global audience.

• For cryptocurrencies, NFTs, or DeFi tokens, use the symbol described on their website or use the symbol from [CoinMarketCap :octicons-tab-external-16:][coinmarketcap]{:target="_blank"} or [CoinGecko :octicons-tab-external-16:][coingecko]{:target="_blank"} websites.

• To write a crypto amount, place the symbol after the number.

• To write fiat, use the [ISO4217 :octicons-tab-external-16:][ISO4217] currency symbol after the amount. If you're using fiat to illustrate a concept, use [commonly-known currencies :octicons-tab-external-16:][wikipedia-common-currencies] like the USA dollar (USD), Euro (EUR), or Japanese yen (JPY).

• For units of measure, use the [metric system :octicons-tab-external-16:][wikipedia-metric-system] and, if necessary, include the imperial units :octicons-tab-external-16:{:target="_blank"} conversion in parenthesis immediately after.

Links

Use links to other articles in the Status documentation, but don't abuse links. For example, don't make the topic look like a Wikipedia article with a link in every sentence.

• Limit the links for sources outside the Status documentation.

• Don't use links in procedural steps, except when you link to a subtask in the same article.

• In the user documentation, don't use anchor links and don't link to anchor links either (this writing style guide uses anchor links intentionally.)

• In general, write the link without using the URL. If you must use the URL, omit the https:// and the www parts of the URL (if the website allows this).

• Don't hide the linked content using the words here or this. Instead, write out the content you link.

  Usage	Example
  Correct	For more details about tokens, check the Understad Status tokens article
  Incorrect	For more detals about tokens, check this article

• When pointing the user to external sources, start you sentence with For more details.

  Usage	Example
  Correct	For more details about tokens, check the Understad Status tokens article
  Correct	For more details, check the Understad Status tokens article
  Incorrect	To learn more about tokens, check this article
  Incorrect	For more information about tokens, check this article

• For links outside of the Status documentation site, use the :octicons-tab-external-16: icon (part of the [Material for MkDocs icons bundle :octicons-tab-external-16:][material-mkdocs-icons]) at the end of the link description.

  Usage	Example
  Correct	Visit status.im/get :octicons-tab-external-16:.
  Incorrect	Visit https://status.im/get :octicons-tab-external-16:.
  Incorrect	Check the "Safely open apps on your Mac" article at https://support.apple.com/en-us/HT202491.
  Incorrect	Check https://support.apple.com/en-us/HT202491 on the Apple Support website.

• For external links, add the {:target="_blank"} at the end of the URL to open the link in a new browser tab. Example:

  For the Mac version, use the [Status website :octicons-tab-external-16:](https://status.im/get){:target="_blank"}

!!! note To manage URL in the Status documentation, we use a single file per language with all the internal and external links. Refer to the [Contributing :octicons-tab-external-16:][contributors-guide]{:target="_blank"} guide for information about using links in your document.

UI elements

!!! note For readability reasons, the examples in other sections don't use these UI elements conventions.

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.

General guidelines

• Don't write the UI control's type (button, drop-down menu, radio button, etc.), except when it isn't clear you're referring to the UI control. The exceptions to this rule are pop-up menu and check the [...] box.

  Usage	Example
  Correct	To publish your token, click Publish.
  Incorrect	To publish your token, click the Publish button.
  Correct	On the Permission pop-up menu, tap the Write permission.
  Incorrect	On the Permissions pop-up, tap the Write permission.
  Incorrect	On Permissions, tap the Write permission.

• When describing actions across different screens or menu options, use angle brackets (>) to describe the sequence of UI elements.

  Usage	Example
  Correct	Go to Settings > Messages > Privacy.
  Incorrect	Go to Settings, then go to Messages, then tap Privacy.

Format guidelines

• Format the UI element as seen on the screen, even if it contradicts the style conventions in this guide.

• Write out the entire UI label, as seen on the screen.

  Usage	Example
  Correct	Check I understand this is the only time I can see my recovery phrasse in the app.
  Incorrect	Check I understand this is ....

• Use a bold typeface to write UI controls in procedural steps (1, 2, 3, and so on). Don't use the bold typeface outside of the procedural steps.

  Usage	Example
  Correct	You can use the Share action to send pictures or documents: 1. Tap Messages. 2. Tap the picture and tap Share.
  Incorrect	You can use the Share action to send pictures or documents: 1. Tap on the Messages button. 2. Choose the picture and tap Share.

• When you write UI areas or sidebars, use a bold typeface only for the visible part in the UI (check Product names and user interface areas for a description of these areas.) Don't use the bold typeface outside of the procedural steps.

  Usage	Example
  Correct	From the navigation sidebar, click your profile picture.
  Incorrect	From the navigation sidebar, click your profile picture.
  Correct	From the Settings sidebar, click Network Settings.
  Incorrect	From the Settings sidebar, click Network Settings.
  Incorrect	From the Settings sidebar, click Network Settings.

Name conventions

• Use screen (unbolded) to refer to the current screen in the Status app. Don't use window, option, or dialog.

  Usage	Example
  Correct	On the Wallet screen, tap New to create a new wallet.
  Incorrect	On the Wallet window, tap New to create a new wallet.

• Use area or sidebar (unbolded) to describe a particular group of elements on the current screen. Don't use section, panel, or pane. Check the Products and user interface names section for a description of individual UI areas.

  Usage	Example
  Correct	In the content area, right-click your message and and click Edit.
  Incorrect	In the content panel, right-click your message and and click Edit.
  Correct	From the navigation sidebar, click your profile picture.
  Incorrect	From the navigation section, click your profile picture.
  Incorrect	From the navigation sidebar, click your profile picture.

User actions

When you describe a UI interaction, use these action verbs:

Action	Style convention (desktop, web, and mobile)
Go to a menu or screen	Use go to.
Click a URL	For URLs, the verb depends on the user's intent: - To complete another action (for example, to download something), use see. - To review the information on a different article or website, use check out.
Select a single UI element	click (desktop and web) or tap (mobile).
Select one or more user-preferred options from a list	choose Example: Choose a name and highlight colour for your group chat.
Select one or more specific option from a list / select text	select Example: Select any channel with a lock icon from the channel list.
Acion on checkboxes	check the [UI label] box (to enable) / uncheck the [UI label] box (to disable).
Action on switches	turn on/turn off
Go to previous screen	Use return.
Swipe element	Use swipe [left or right] for desktop, web, and mobile.
Long press	long press for mobile interactions, when required.
Right click	right click for desktop and web interactions, when required.
Start session	log in (verb) or login (noun) for desktop, web, and mobile.
End session	log out (verb) or logout (noun) for desktop, web, and mobile.
First-time access	Use create profile.

Admonitions

• Status user documentation uses three different types of admonitions (also known as callouts):

  Admonition	Description
  Tip	Information that is not necessary for the task, but it's helpful or nice to have. For example, information about a keyboard shortcut.
  Note	Information that is relevant to complete the task, but has no impact on the user's actions.
  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.

• Don't use warning, error, danger, bug, important, or notes.

• Don't use admonitions within procedural steps.

• In procedures, place the admonition after the procedure (see Structuring the content for more details.)

• For other content, add the admonition after the relevant information.

Iconography

The Status documentation uses the application icons to guide readers' actions on the app.

• Use icons in procedural steps to guide the user's actions.

• Don't overuse icons. A document with many icons is harder to follow and scan.

• Write the icon first, and then the icon's name in bold typeface. 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 label name in the Icons names reference table.

• Use the Status icons on the /override/.icons folders in the GitHub [user documentation repository :octicons-tab-external-16:][status-github-user-doc-repo]{:target="_blank"}.

• 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 desktop icon under the .icons\desktop directory is desktop-wallet.svg; to show this icon in a sentence, use:

  Tap :desktop-wallet: Wallet and save your settings.
  

Symbols and punctuation marks

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.

Usage	Example
Correct	To quote text inline, use the greater-than sign (>) before your text.
Incorrect	To quote text inline, use the bigger-than sign (>) before your text.

Modal verbs

Modal verbs are auxiliary verbs that modify the meaning of the main verb in a sentence. Modal verbs can be problematic in technical communication:

• Some modal verbs create a sense of uncertainty in readers.

• Using modal verbs like should or must makes your tone bossier and less helpful. In many cases, using the imperative is a better option. For example:

  Tone	Example
  Bossy	You should save your seed phrase in a secure location.
  Assertive	Save your seed phrase in a secure location.

• Use this reference for the most frequent modal verbs:

  Modal verb	Usage
  can	Use it to express the possibility of the user to do something, like when you're introducing a new concept or functionality. Example: You can create multiple wallets for different purposes.
  should	If possible, use the imperative form of the verb instead.
  have to	Use must instead.
  must	Use it very selectively and only when it's strictly necessary for the user to do something to avoid data or funds loss, data corruption, or unintended information disclosure.
  could, would, might	Don't use.

Possessive form

• Use the possessive form with caution and avoid complex possessive forms like the [compound possessive :octicons-tab-external-16:][grammarly-compound-possessive]{:target="_blank"}. Some non-native English readers may have problems understanding sentences with possessive forms.

  Usage	Example
  Correct	[...] your contact's status.
  Incorrect	[...] your contact's verified status.
  Correct	[...] the verified status of the contact.
  Correct	[...] the picture shared by you and your trusted contact.
  Incorrect	[...] you and your trusted contact's shared picture.

• Use a single straight quotation mark (') apostrophe. Don't use curly quotation marks (also known as smart quotes.)

• If you have to use a passive form with a proper name ending with the possessive s, add the apostrophe at the end without an extra s letter.

  Usage	Example
  Correct	Check your contacts' list.
  Incorrect	Check your contacts's list.

• If the possessor is not a person, you don't need to add an apostrophe to show possession.

  Usage	Example
  Correct	Verify the contact's ENS name on the Status details screen.
  Incorrect	Verify the contact's ENS name on the Status' details screen.
  Correct	Your profile information stays in your browser cache.
  Incorrect	Your profile information stays in your browser's cache.

Contractions

• Use contractions to make your text more casual.

	Usage	Example
	Use	you're / isn't / can't / it's / can't
	Avoid	you are / is not / cannot / it is / cannot

• Avoid the 'd (had or would) and 've (have) contractions, as these may be difficult to understand for non-native speakers.

Global writing

• Don't use idioms, colloquial expressions, and culture-specific references. When writing examples to clarify a feature or concept, don't use historical references, brand names, social or political events, or any other topic that might be controversial or meaningless for a global audience.
• Observe the style rules for numbers, date and time, and units of measure.
• 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.
• 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.
• Don't use pronouns like Who, Whose, or Its; replace the pronoun with the noun.
• Avoid using (s) for plural forms.

  Usage	Example
  Correct	Every file upload requires special permissions.
  Incorrect	The file(s) upload requires special permissions.
  Correct	This option returns each token on your list alphabetically.
  Incorrect	This option returns the token(s) on your list alphabetically.

Other style conventions

• Use everyday language. Don't use jargon, technicalities, flowery or made-up words, or wordy constructions.

• It's OK to repeat important information through the text. Readers scan the content; they don't read the content, so there are chances they miss this information.

• Use gender-neutral language. Don't use he and she, him or her, he/she or similar. Instead, use neutral nouns like user, administrator, or content creator.

• Use the same word for the same concept consistently. Avoid using synonyms to refer to the same idea or feature.

• Don't use we recommend [...] or Status recommends [...]. Recommendations create doubts in the reader's mind. Instead, explain to users what to do and, if necessary, the consequences of doing or not doing it.

• Don't use please in technical documentation. Readers look for assertiveness when reading instructions.

• Don't try to be funny, express emotions with exclamation marks, or ask readers rhetorical questions. Users are not interested in reading prose but in getting things done.

  Usage	Example
  Incorrect	Want to personalize and customize your profile for how it appears to other Community members? If so, follow these instructions below!

• It's OK to use prepositions at the end of sentences (for example, the user you're searching for).

• Don't use italics or quotes to introduce a new concept; in general, don't use them on any part of the text (except when writing a UI element that uses italics or quotes.)

• Use code formatting to distinguish parameters or options from the rest of your text when discussing them outside of procedure steps.

  Usage	Example
  Correct	You can use the Is Allowed and In options to modify the permission scope.
  Incorrect	You can use the Is Allowed and In options to modify the permission scope.
  Incorrect	You can use the Is Allowed and In options to modify the permission scope.

• Avoid sentence connectors, such as therefore, hence, or as a consequence. Rewrite the sentences if necessary.

• Don't use adjectives to describe a task's difficulty or time required.

  Usage	Example
  Incorrect	You can easily set up your community.
  Incorrect	Using our app, you can mint your NFT in no time.

• Keep phrasal verbs together.

  Usage	Example
  Correct	Execute the command shutdown -h now to shut down the server.
  Incorrect	Execute the command shutdown -h now to shut the server down.

• Avoid referring to the document itself using On this procedure, In this document, In the following list, In this section, or similar expressions. Use here instead.

  Usage	Example
  Correct	Here you can find the list of keyboard shortcuts.
  Incorrect	In the following section, you can find the list of keyboard shortcuts.

Spelling

Use the Oxford spelling.

• Use the suffix -ize instead of -ise. As such, write organize and organization, not organise and organisation.
• The rule above doesn't affect the spelling of words ending in -yse, such as analyse.
• Some examples of the Oxford spelling include: globalization, behaviour, centre, defence, catalogue, programme.
• If in doubt about any spelling, feel free to use the [Cambridge Dictionary][cambridge-dictionary]{:target="_blank"}.

[:octicons-git-branch-24: Contribute to our docs][contributors-guide]{ .md-button }

--8<-- "includes/urls-style-guide.txt"