Skip to content

Commit

Permalink
Updated Style Guide
Browse files Browse the repository at this point in the history
- Edited most of non-Nordic mentions.
- Edited line breaks to match Nordic Style.

Signed-off-by: Francesco Domenico Servidio <[email protected]>
  • Loading branch information
FrancescoSer committed Mar 11, 2024
1 parent 8baaaeb commit 220e763
Show file tree
Hide file tree
Showing 9 changed files with 306 additions and 256 deletions.
97 changes: 41 additions & 56 deletions docs/acronyms.md
Original file line number Diff line number Diff line change
@@ -1,100 +1,85 @@
---
title: Acronyms - Microsoft Style Guide
author: pallep
ms.author: pallep
ms.date: 01/19/2018
ms.topic: article
ms.prod: non-product-specific
---

# Acronyms

Acronyms
and abbreviations can have an adverse effect on clarity, voice, and
SEO. Although some acronyms are widely understood and preferred to the
spelled-out term, others aren't well known or are familiar only to a
specific group of customers.
Acronyms and abbreviations can have an adverse effect on clarity, voice, and SEO.
Although some acronyms are widely understood and preferred to the spelled-out term, others aren't well known or are familiar only to a specific group of customers.

## Don't create acronyms from product or feature names

Always
spell out Microsoft product and feature names.
Always spell out Nordic Semiconductor product and feature names.

## Only use acronyms that your audience is familiar with

The A–Z word list has guidelines for many common acronyms, and some acronyms are so widely used that they're in *[The American Heritage Dictionary](https://ahdictionary.com/).*
The A–Z word list has guidelines for many common acronyms, and some acronyms are so widely used that they're in *[The American Heritage Dictionary](https://ahdictionary.com/).*

## If you have to use an acronym, also spell out the term for clarity

In
general, include the acronym in parentheses following the spelled-out
term. On subsequent mentions in the same article, page, or screen, you can
use the acronym without spelling it out.
In general, include the acronym in parentheses following the spelled-out term.
On subsequent mentions in the same article, page, or screen, you can use the acronym without spelling it out.


Some acronyms, like *USB, FAQ,* and *URL,* are more well known than the spelled-out term. Don't spell out the term if the acronym is listed in *[The American Heritage Dictionary](https://ahdictionary.com/)* or if the A–Z word list
says to use the acronym without spelling it out. If you're sure your
audience is familiar with an acronym, it's OK to use it without spelling
it out.
Some acronyms, like *USB, FAQ,* and *URL,* are more well known than the spelled-out term.
Don't spell out the term if the acronym is listed in *[The American Heritage Dictionary](https://ahdictionary.com/)* or if the A–Z word list says to use the acronym without spelling it out.
If you're sure your audience is familiar with an acronym, it's OK to use it without spelling it out.

**Examples**
Conversation as a platform (CaaP) has the potential to make booking a flight as easy as sending a text message. Developers are also looking to CaaP to make computing more accessible to users of all abilities.
Learn how to connect a USB device to your Microsoft Surface.
**Examples**
Conversation as a platform (CaaP) has the potential to make booking a flight as easy as sending a text message.
Developers are also looking to CaaP to make computing more accessible to users of all abilities.

TODO

## Don't introduce acronyms that are used just once

If
an acronym will appear only once in your content, just spell out the
term. Don't introduce it in parentheses after the spelled-out version.
If an acronym will appear only once in your content, just spell out the term.
Don't introduce it in parentheses after the spelled-out version.

**Exception** It's OK to use both the spelled-out term and the acronym if both are needed for SEO, even if the acronym is used only once.

## Be careful with acronyms in titles and headings

Avoid
using an acronym for the first time in a title or heading, unless it's a
keyword that you need to place in the title or heading for SEO. If the
first use of the acronym is in a title or heading, introduce the acronym
(in parentheses, following the spelled-out term) in the following body
text.
Avoid using an acronym for the first time in a title or heading, unless it's a keyword that you need to place in the title or heading for SEO.
If the first use of the acronym is in a title or heading, introduce the acronym (in parentheses, following the spelled-out term) in the following body text.


## Lowercase the spelled-out term

Lowercase
all words in the spelled-out form of an acronym except for proper
nouns. The names of many protocols and specifications are considered
proper nouns and are capitalized when spelled out.
Lowercase all words in the spelled-out form of an acronym except for proper nouns.
The names of many protocols and specifications are considered proper nouns and are capitalized when spelled out.

**Examples**
infrastructure as a service (IaaS)
dynamic-link library (DLL)<br>High-Definition Multimedia Interface (HDMI)
**Examples**
infrastructure as a service (IaaS)
dynamic-link library (DLL)
High-Definition Multimedia Interface (HDMI)

## Use *a* or *an,* depending on pronunciation

Which article (*a* or *an*) you use depends on whether you pronounce the acronym like a word or pronounce each letter.

**Examples**
a DLL
an ISP
a URL
**Examples**
a DLL
an ISP
a URL
an SQL database

**Add *s* to make an acronym plural**

Form the plural of an acronym like you would any other noun. If the acronym stands for a singular noun, add a lowercase *s* to make it plural. If an acronym stands for a plural noun, don’t add an *s.*
Form the plural of an acronym like you would any other noun.
If the acronym stands for a singular noun, add a lowercase *s* to make it plural.
If an acronym stands for a plural noun, don’t add an *s.*

**Examples**
three APIs
Microsoft Foundation Classes (MFC)
**Examples**
three APIs
TODO

## Avoid the possessive form

Unless an acronym refers to a person or an organization, avoid using the possessive form.

**Examples**
the IDE enhancements
the purpose of the FAQ
**Examples**
the IDE enhancements
the purpose of the FAQ
the CEO’s blog

**Global tip** In machine-translated content, be careful with acronyms that form common English words, like *RAM.* If the acronym appears outside of the parentheses and without the spelled-out version, it might be translated incorrectly.
**Global tip** In machine-translated content, be careful with acronyms that form common English words, like *RAM*.
If the acronym appears outside of the parentheses and without the spelled-out version, it might be translated incorrectly.

**See also** [Bits and bytes term collection](~/a-z-word-list-term-collections/term-collections/bits-bytes-terms.md), [Units of measure term collection](~/a-z-word-list-term-collections/term-collections/units-of-measure-terms.md)
84 changes: 38 additions & 46 deletions docs/bias-free-communication.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
---
title: Bias-free communication - Microsoft Style Guide
author: pallep
ms.author: pallep
ms.date: 09/13/2019
ms.topic: article
ms.prod: non-product-specific
---

# Bias-free communication

Microsoft technology reaches every part of the globe, so it's critical that all our communications are inclusive and diverse.
Nordic Semiconductor technology reaches every part of the globe, so it's critical that all our communications are inclusive and diverse.

**Use gender-neutral alternatives for common terms.**

Expand All @@ -23,14 +14,15 @@ Microsoft technology reaches every part of the globe, so it's critical that all
| synthetic, manufactured | manmade |
| workforce, staff, personnel | manpower |

**Don't use *he, him, his, she, her,* or *hers* in generic references.** Instead:
- Rewrite to use the second person (*you*).
**Don't use *he, him, his, she, her,* or *hers* in generic references.** Instead:
- Rewrite to use the second person (*you*).
- Rewrite the sentence to have a plural noun and pronoun.
- Use *the* or *a* instead of a pronoun (for example, "the document").
- Use *the* or *a* instead of a pronoun (for example, "the document").
- Refer to a person's role (*reader, employee, customer,* or *client,* for example).
- Use *person* or *individual.*
- Use *person* or *individual.*

If you can't write around the problem, it's OK to use a plural pronoun (*they, their,* or *them*) in generic references to a single person. Don't use constructions like *he/she* and *s/he.*
If you can't write around the problem, it's OK to use a plural pronoun (*they, their,* or *them*) in generic references to a single person.
Don't use constructions like *he/she* and *s/he.*


| **Use this** | **Not this** |
Expand All @@ -41,43 +33,40 @@ If you can't write around the problem, it's OK to use a plural pronoun (*they, t
| To call someone, select the person's name, select **Make a phone call**, and then choose the number you'd like to dial. | To call someone, select his name, select **Make a phone call**, and then select his number. |
| If you want to call someone who isn't in your Contacts list, you can dial their phone number using the dial pad. | If you want to call someone who isn't in your Contacts list, you can dial his or her phone number using the dial pad. |

**When you're writing about a real person, use the pronouns that person prefers,** whether it's *he, she, they,*
or another pronoun. It's OK to use gendered pronouns (like *he, she, his,* and *hers*) when you're
writing about real people who use those pronouns themselves.
**When you're writing about a real person, use the pronouns that person prefers,** whether it's *he, she, they,* or another pronoun.
It's OK to use gendered pronouns (like *he, she, his,* and *hers*) when you're writing about real people who use those pronouns themselves.

It's also OK to use gendered pronouns in content such as direct quotations and the titles of works and when gender
is relevant, such as discussions about the challenges that women face in the workplace.
**Examples**
The skills that Claire developed in the Marines helped her move into a thriving technology career.
Anthony Lambert is executive vice president of gaming. With his team and game development partners,
Lambert continues to push the boundaries of creativity and technical innovation.
The chief operating officer of Munson's Pickles and Preserves Farm says, "My great uncle Isaac, who employed
his brothers, sisters, mom, and dad, knew that they—and his customers—were depending on him."
Do you have a daughter? Here are a few things you can do to inspire and support her interest in STEM subjects.
It's also OK to use gendered pronouns in content such as direct quotations and the titles of works and when gender is relevant, such as discussions about the challenges that women face in the workplace.
**Examples**
The skills that Claire developed in the Marines helped her move into a thriving technology career.
Anthony Lambert is executive vice president of gaming.
With his team and game development partners, Lambert continues to push the boundaries of creativity and technical innovation.
The chief operating officer of Munson's Pickles and Preserves Farm says, "My great uncle Isaac, who employed his brothers, sisters, mom, and dad, knew that they—and his customers—were depending on him."
Do you have a daughter?
Here are a few things you can do to inspire and support her interest in STEM subjects.

**In fictitious scenarios, strive for diversity and avoid stereotypes in job roles.** Choose names that reflect
a variety of gender identities and cultural backgrounds.
**In fictitious scenarios, strive for diversity and avoid stereotypes in job roles.**
Choose names that reflect a variety of gender identities and cultural backgrounds.

**In text and images, represent diverse perspectives and circumstances.** Depict a variety of people from all
walks of life participating fully in activities. Be inclusive of gender identity, race, culture, ability, age,
sexual orientation, and socioeconomic class. Show people in a wide variety of professions, educational settings,
locales, and economic settings. Avoid using examples that reflect primarily a Western or affluent lifestyle.
In drawings or blueprints of buildings, show ramps for wheelchair accessibility.
**In text and images, represent diverse perspectives and circumstances.**
Depict a variety of people from all walks of life participating fully in activities.
Be inclusive of gender identity, race, culture, ability, age, sexual orientation, and socioeconomic class.
Show people in a wide variety of professions, educational settings, locales, and economic settings.
Avoid using examples that reflect primarily a Western or affluent lifestyle.
In drawings or blueprints of buildings, show ramps for wheelchair accessibility.

**Be inclusive of job roles, family structure, and leisure activities.** If you show various family groupings,
consider showing nontraditional and extended families.
**Be inclusive of job roles, family structure, and leisure activities.**
If you show various family groupings, consider showing nontraditional and extended families.

**Be mindful when you refer to various parts of the world.** If
you name cities, countries, or regions in examples, make sure
they're not politically disputed. In examples that refer to several
regions, use equivalent references—for example, don't mix
countries with states or continents.
**Be mindful when you refer to various parts of the world.*
If you name cities, countries, or regions in examples, make sure they're not politically disputed.
In examples that refer to several regions, use equivalent references—for example, don't mixcountries with states or continents.

**Don't make generalizations about people, countries, regions, and cultures,** not even positive or neutral generalizations.
**Don't make generalizations about people, countries, regions, and cultures,** not even positive or neutral generalizations.

**Don't use slang,** especially if it could be considered cultural appropriation, such as *spirit animal.*
**Don't use slang.**

**Don't use profane or derogatory terms,** such as *pimp* or *bitch.*
**Don't use profane or derogatory terms.**

**Avoid culturally sensitive terms,** such as the terms associated with military or political actions or other historic events and eras.

Expand All @@ -88,8 +77,11 @@ countries with states or continents.
| perimeter network | demilitarized zone (DMZ) |
| stop responding | hang |

**Focus on people, not disabilities.** For example, talk about readers who are blind or have low vision and customers with limited dexterity. Don't use words that imply pity, such as *stricken with* or *suffering from.* Don't mention a disability unless it's relevant. For more information, see the [Accessibility term collection](~/a-z-word-list-term-collections/term-collections/accessibility-terms.md).
**Focus on people, not disabilities.** For example, talk about readers who are blind or have low vision and customers with limited dexterity.
Don't use words that imply pity, such as *stricken with* or *suffering from.*
Don't mention a disability unless it's relevant.
For more information, see the [Accessibility term collection](~/a-z-word-list-term-collections/term-collections/accessibility-terms.md).

**Learn more** For more information about writing that conveys respect to all people and promotes equal opportunities, see the [Guidelines for Inclusive Language](https://www.linguisticsociety.org/content/guidelines-inclusive-language "Linguistic Society of America's guidelines for inclusive language") from the Linguistic Society of America.
**Learn more** For more information about writing that conveys respect to all people and promotes equal opportunities, see the [Guidelines for Inclusive Language](https://www.linguisticsociety.org/content/guidelines-inclusive-language "Linguistic Society of America's guidelines for inclusive language") from the Linguistic Society of America.

**See also** [Accessibility guidelines and requirements](~/accessibility/accessibility-guidelines-requirements.md), [Global communications](~/global-communications/index.md)
41 changes: 16 additions & 25 deletions docs/brand-voice-above-all-simple-human.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,60 @@
---
title: Microsoft's brand voice &#58; above all, simple and human - Microsoft Style Guide
author: pallep
ms.author: pallep
ms.date: 01/19/2018
ms.topic: article
ms.prod: non-product-specific
---

# Microsoft's brand voice: Above all, simple and human
# Nordic Semiconductor's brand voice: Above all, simple and human

There’s *what* we say, our message. And there’s *how*
we say it, our voice.
we say it, our voice.

## What do we mean by voice?

The Microsoft voice is how we talk to people. It’s the interplay of personality, substance, tone, and style.
The Nordic Semiconductor voice is how we talk to people. It’s the interplay of personality, substance, tone, and style.

Though
our voice is constant regardless of who we’re talking to or what we’re
saying, we adapt our tone—from serious to empathetic to lighthearted—to
fit the context and the customer's state of mind.
fit the context and the customer's state of mind.

## Three voice principles

Our voice hinges on crisp simplicity. Bigger ideas and fewer words. Less head, more heart.
Our voice hinges on crisp simplicity. Bigger ideas and fewer words. Less head, more heart.

Our voice is:

- **Warm and relaxed**—We’re
natural. Less formal, more grounded in real, everyday conversations.
Occasionally, we’re fun. (We know when to celebrate.)
- **Crisp and clear**—We’re to the point. We write for scanning first, reading second. We make it simple above all.
Occasionally, we’re fun. (We know when to celebrate.)

- **Crisp and clear**—We’re to the point. We write for scanning first, reading second. We make it simple above all.

- **Ready to lend a hand**—We show customers we’re on their side. We anticipate their real needs and offer great information at just the right time.

## A focus on the customer

Talking to our customers in a way
that’s warm and relaxed, crisp and clear, and ready to lend a hand reflects our commitment to empowering
that’s warm and relaxed, crisp and clear, and ready to lend a hand reflects our commitment to empowering
people to achieve more.

**Style tips**

A few key elements of writing Microsoft’s voice:
A few key elements of writing Nordic Semiconductor’s voice:

- **Get to the point fast.** Start
with the key takeaway. Put the most important thing in the most
noticeable spot. Make choices and next steps obvious. Give people
just enough information to make decisions confidently. Don’t get in
the way.
the way.

- **Talk like a person.** Choose
optimistic, conversational language. Use short everyday words,
contractions, and sentence-style capitalization. Shun jargon and
acronyms. And never miss an opportunity to find a better
word.
word.

- **Simpler is better.** Everyone
likes clarity and getting to the point. Break it up. Step it out.
Layer. Short sentences and fragments are easier to scan and read.
Prune every excess word.

**Get started**

For more quick techniques, check out the [Top 10 tips for Microsoft style and voice](~/top-10-tips-style-voice.md).
For more quick techniques, check out the [Top 10 tips for Nordic Semiconductor style and voice](~/top-10-tips-style-voice.md).

Remember that writing is a skill. If writing isn't a functional role your team has, consider bringing in expert help.
Loading

0 comments on commit 220e763

Please sign in to comment.