;
}
};
Writing should be simple, direct, and consistent, avoiding jargon and unnecessary complexity. Inclusive language ensures that everyone feels represented and respected, while accessibility considerations make content usable for a diverse audience.
## Language for Best Practices
### Clarity and Simplicity
**Use Plain Language**: Write copy that’s easy to understand on the first read. Avoid complex words and jargon, and focus on simple, everyday language.
**Be Concise**: Keep sentences short and to the point. Ensure each word adds value and there is no unnecessary padding.
#### How to Use
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Update your profile.
);
}
export default App;
```
**Do**
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Proceed with the process to modify your profile settings.
);
}
export default App;
```
**Don't**
### Use Familiar Terms
**Avoid technical jargon**: Use familiar, everyday terms that resonate with the average user. If a term is necessary, provide simple explanations.
**Consistent terminology**: Stick to consistent terminology across all in-app elements to avoid confusion. Use the same words to describe the same features or actions throughout the app.
#### How to Use
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Log in to access your dashboard.
);
}
export default App;
```
**Do**
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Authenticate yourself to gain access to your control center.
);
}
export default App;
```
**Don't**
### Positive and Reassuring Tone
**Reinforce confidence**: Use a positive, friendly tone to make users feel in control. Avoid using language that makes them feel uncertain or stressed about the actions they’re taking.
#### How to Use
```tsx lines theme={null}
import { Alert, Flex } from "@servicetitan/anvil2";
function App() {
return (
Please continue to the next section.
);
}
export default App;
```
**Do**
```tsx lines theme={null}
import { Alert, Flex } from "@servicetitan/anvil2";
function App() {
return (
);
}
export default App;
```
**Don't**
Use generic error messages that don’t help the user understand or resolve the issue.
## Inclusivity Best Practices
### Gender-neutral Language
**Avoid gendered pronouns**: Use gender-neutral pronouns like “they” instead of “he” or “she.” This ensures inclusivity and respects the diversity of your users.
**Neutral job titles and descriptions**: Use terms that don’t imply gender. For instance, use "salesperson" instead of "salesman."
#### How to Use
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Enter your first and last name.
);
}
export default App;
```
**Do**
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
First name (John), Last name (Smith).
);
}
export default App;
```
**Don't**
Use vague terms like "Click Here" that don’t provide context.
### Accessibility Considerations
**Keep Copy Simple**: Ensure your copy is easy to understand by users with varying cognitive abilities or language proficiency. Use simple sentence structures and avoid long paragraphs.
**Ensure Readability**: Use familiar vocabulary and straightforward instructions. Write at an appropriate reading level, avoiding overly academic or complex phrases.
#### How to Use
```tsx lines theme={null}
import { Text, Flex, Link } from "@servicetitan/anvil2";
function App() {
return (
You can find help here.
);
}
export default App;
```
**Do**
```tsx lines theme={null}
import { Text, Flex, Link } from "@servicetitan/anvil2";
function App() {
return (
Assistance can be located via this portal.
);
}
export default App;
```
**Don't**
### Avoid Stereotypes and Bias
**Respect all genders, ages, and abilities**: Be mindful not to include language that reinforces stereotypes about gender, age, race, or abilities.
**Avoid assumptive language**: Refrain from assuming a user’s background, preferences, or level of experience.
### Inclusive Pronouns and Phrasing
**Use "They"**: When referring to a hypothetical user or person, always use "they" as a singular, gender-neutral pronoun. This ensures that you are addressing all genders inclusively.
**Use Inclusive Phrases**: Replace words and phrases that could exclude certain groups with more inclusive alternatives.
#### How to Use
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Each person is responsible for their own tasks.
);
}
export default App;
```
**Do**
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Each man is responsible for his own tasks.
);
}
export default App;
```
**Don't**
## Disability Language
* In general, refer to the person first and the disability second—*People with disabilities* or *Customers who are deaf or hard-of-hearing*
* Emphasize accessibility over disability—Use *Accessible restroom*, not *Disabled restroom*
* Avoid euphemisms like *physically challenged*, *handi-capable*,or *special needs*
For more, see the [NCDJ Disability Language Style Guide](https://ncdj.org/style-guide/), [APA Style Guidelines on Disability](https://apastyle.apa.org/style-grammar-guidelines/bias-free-language/disability), and the [National Association for the Deaf FAQ](https://www.nad.org/resources/american-sign-language/community-and-culture-frequently-asked-questions/).
#### How to Use
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
People with disabilitiesPeople without disabilitiesCustomers who are deaf or hard-of-hearingPeople with limited visionPerson who is blindAccessibility parking
);
}
export default App;
```
**Do**
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Handicapped people or The disabledNormal people, Regular people, or Able-bodied peopleHearing impaired customers or Deaf customersThe visually impairedBlind person or The blindHandicapped parking
);
}
export default App;
```
**Don't**
## Colors and Screen Navigation
#### How to Use
When possible, avoid overly specific screen location instructions, which can be confusing for those with directional impairment.
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Selected options are highlighted
);
}
export default App;
```
**Do**
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
Selected options are highlighted in blue
);
}
export default App;
```
**Don't**
#### How to Use
When possible, avoid overly specific screen location instructions, which can be confusing for those with directional impairment.
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
At the bottom of the screen, click Save.
);
}
export default App;
```
**Do**
```tsx lines theme={null}
import { Text, Flex } from "@servicetitan/anvil2";
function App() {
return (
In the bottom right corner of the screen, click Save.
);
}
export default App;
```
**Don't**
