diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 27fcc0b16f9..00000000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "editor.formatOnSave": true, - "eslint.lintTask.enable": true, - "editor.codeActionsOnSave": { - "source.fixAll.eslint": true - } -} diff --git a/src/pages/guidelines/content/writing-style.mdx b/src/pages/guidelines/content/writing-style.mdx index 334f04bc0e2..dd67353205b 100755 --- a/src/pages/guidelines/content/writing-style.mdx +++ b/src/pages/guidelines/content/writing-style.mdx @@ -3,7 +3,7 @@ title: Content description: Writing should always be simple, clear, and easy to understand. Using everyday language keeps the tone friendly, human, and inviting. And choose short words - over long impressive-sounding words. Put the thesaurus away! + over long, impressive–sounding words. Put the thesaurus away! tabs: ['Overview', 'Writing style', 'Action labels'] --- @@ -11,7 +11,7 @@ tabs: ['Overview', 'Writing style', 'Action labels'] Writing should always be simple, clear, and easy to understand. Using everyday language keeps the tone friendly, human, and inviting. And choose short words -over long impressive-sounding words. Put the thesaurus away! +over long, impressive–sounding words. Put the thesaurus away! @@ -28,9 +28,9 @@ over long impressive-sounding words. Put the thesaurus away! ## Capitalization -### Use sentence-case capitalization +### Use sentence–case capitalization -Use sentence-case capitalization for all UI text elements. This style is +Use sentence–case capitalization for all UI text elements. This style is predominantly lowercase. Capitalize only the initial letter of the first word in the text and other words that require capitalization, such as proper nouns. For example, labels in a form would be written as “First name” and “Email address”. @@ -43,19 +43,19 @@ text, table headers, and table content all following the sentence case rule. ![Sentence case for UI elements](/images/sentence_case_786.png) -Example of a product page using sentence-style capitalization +Example of a product page using sentence–style capitalization -Sentence-style capitalization makes it easy for readers to distinguish between +Sentence–style capitalization makes it easy for readers to distinguish between common nouns and proper nouns, and is generally considered the quickest form to read. > Do not capitalize the names of features and components unless they are sold > separately or are trademarked. > -> - The IBM Style Guide: Conventions for Writers and Editors +> – The IBM Style Guide: Conventions for Writers and Editors Carbon does not consider UI elements within a product to be proper nouns. Nor does Carbon support a concept of “important words” or “specialness”. Determining @@ -63,7 +63,7 @@ whether something is important or special is highly subjective and can result in inconsistencies across an organization. Unless the name is a product or service name, or is trademarked, always use -sentence-style capitalization. +sentence–style capitalization. In the following examples, the capitalization shows that Padlock, Visual Recognition, and IBM Cloud are either products or services. @@ -145,7 +145,7 @@ Capital letters are reserved for the following: - “Carbon” or the “Carbon Design System” (the name of IBM’s official design system) - “IBM” or any other company or organization name -- Any official, trademarked product or service (whether from IBM or not) - +- Any official, trademarked product or service (whether from IBM or not) – unless they intentionally use a lowercase letter at the beginning, such as the iPhone - Any initialisms (for example, BBC, HTML) or acronyms (for example, NASA, NATO) @@ -156,7 +156,7 @@ Capital letters are reserved for the following: If it’s not in the list above, it should not be capitalized. -Sometimes official company and product names use non-standard capitalization. If +Sometimes official company and product names use non–standard capitalization. If you refer to any of these, ensure you write them accurately. Here are some examples (all written correctly): @@ -170,8 +170,8 @@ examples (all written correctly): When writing about a UI element, use the same capitalization as used in the UI. For example, if an input field is labeled “Name” then you refer to this as the -Name input field. Similarly, if a drop-down menu has the label “Country” next to -it, then it is correct to refer to the Country drop-down menu. Where a product +Name input field. Similarly, if a drop–down menu has the label “Country” next to +it, then it is correct to refer to the Country drop–down menu. Where a product page is titled “My network”, you refer to this in writing as follows: “Enter your network information in the My network page”. @@ -225,7 +225,7 @@ been specifically approved, as with IBM CICS. -Use all uppercase letters for well-recognized abbreviations. This applies to +Use all uppercase letters for well–recognized abbreviations. This applies to both initialisms, such as IBM, and to acronyms, such as GIF. - ASCII @@ -295,7 +295,7 @@ has, had, been, should, would, and will. To set the appropriate tone and conversation level, it helps to imagine the user engaging with the product as if in a conversation. The interplay between words, -imagery, and interactions forms the conversation, a back-and-forth that takes +imagery, and interactions forms the conversation, a back–and–forth that takes place on the glass, between the user and the product. The conversational level is determined by where the user is in the journey, and @@ -307,7 +307,7 @@ of words is desirable. Whatever the conversational level, the writing should always be simple, clear, and easy to understand. And keep the tone friendly, human, and inviting. Use everyday language, not jargon. And choose short words to make the reading -faster, rather than long impressive-sounding words. Put the thesaurus away! +faster, rather than long, impressive–sounding words. Put the thesaurus away! IBM Style offers more guidelines on [conversational style](<[https://www-03preprod.ibm.com/support/knowledgecenter/ibm_style/conversational-style.html](https://ibmdocs-test.mybluemix.net/docs/en/ibm-style?topic=medium-conversational-style)>). @@ -410,10 +410,10 @@ offerings be inclusive in their language. IBMers who are unsure about a particular word can search the [IBM Terminology database](http://ibm.biz/termsearch), and can -also [submit a term for review](http://tlwi.w3-969.ibm.com/standards/terminology/feedbackform2.html). +also [submit a term for review](http://tlwi.w3-969.ibm.com/standards/terminology/feedbackform2.html). For more information about this important work, see -the [Inclusive IT Terminology](https://w3.ibm.com/w3publisher/inclusive-it-terminology/take-action) site. +the [Inclusive IT Terminology](https://w3.ibm.com/w3publisher/inclusive-it-terminology/take-action) site. ## Pronouns @@ -441,7 +441,7 @@ requests for personal information, such as name and email address, where the user will benefit from knowing why IBM is asking for this information. Example: “Why do we need your email address?” -Avoid third-person pronouns that are gender specific. +Avoid third–person pronouns that are gender specific. For more detailed guidance about pronouns, refer to the [Pronouns](https://ibmdocs-test.mybluemix.net/docs/en/ibm-style?topic=grammar-pronouns)