Skip to content

Commit

Permalink
Merge pull request #2091 from dfinity/update-style-guide
Browse files Browse the repository at this point in the history
Update style guide
  • Loading branch information
jessiemongeon1 authored Oct 30, 2023
2 parents 4b33484 + db88658 commit 15671e8
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ Capitalization within the developer documentation should follow these outlined s
The following proper nouns should always be capitalized:
- Blockchain Singularity
- Candid
- DFINITY
- DFINITY Foundation
- Internet Computer
- Internet Computer Protocol
Expand Down Expand Up @@ -244,19 +245,22 @@ The following is a list of common abbreviations that are capitalized within the
- IC
- ICP
- ICRC-1
- ICRC-2
- II
- IOS
- NFT
- NNS
- SDK
- SNS
- XDR
- UTXO

## Language
The following language and capitalization of certain terms and phrases should be used across the IC developer documentation:
- Big Tech
- Bitcoin integration
- Bitcoin network: should be used in place of "sending bitcoin".
- Bitcoin network: should be used in place of "sending bitcoin".
- bitcoin: should be used when referring to BTC rather than the Bitcoin network.
- Built on the Internet Computer
- canister
- canister smart contract
Expand Down Expand Up @@ -284,6 +288,9 @@ The following language and capitalization of certain terms and phrases should be

### Spelling, grammar, and word choice
The following spelling, grammar, and word choice rules should be followed:
- Avoid using language that uses 'we' or 'us'; use a protocol point of view, such as phrases like, "the protocol ensures", "the protocol does", and “it is explained” rather than “we explain”.
- An exeption to this is the Developer Blog; blog posts are written using a different style for a different audience, and using 'we' or 'us' in this context is acceptable.
- Do not refer to the Internet Computer as a system or a platform. Say "Internet Computer" or "protocol" instead.
- Regarding spelling and grammar, American spelling and grammar should be used with the exception that all article titles follow British capitalization rules (see details in the Capitalization section.)
- Assure that the language in the document reads well for non-native English speakers, and avoid phrases or sayings that may be confusing, such as "Dig in."
- Avoid informal, personal thoughts or otherwise unnecessary language within the developer docs. A few examples of this might be:
Expand All @@ -303,10 +310,10 @@ The following spelling, grammar, and word choice rules should be followed:
- "Here is a checklist of the things you will need to consider:"

## Numbers
Numbers should be formatted using the `'` character, and not any other character. For example:
- 44'760'000
- 54'000
- 1'000
Numbers should be formatted using the `_` character, and not any other character. For example:
- 44_760_000
- 54_000
- 1_000

## API methods

Expand Down

0 comments on commit 15671e8

Please sign in to comment.