Body
General Guidelines
Uniformity
- Use the appropriate template
- Define the audience
- Pay attention to disability/accessibility practices
- Reference neither a client nor an incident
- Write concisely using language the audience uses
- Click to notify owner of feedback when creating article
Quality
- Use spell checker
- Proofread the article before submitting / publishing
- Use screens/videos as supplement to the text and only when valuable for the audience or complexity of solution
- Readability
- Use bullets wherever possible
- Number steps for directions
- Do not create duplicates
- Define abbreviations and acronyms with first use
Searchability
- Use service catalog names for products and services, and list other names customers know them by
- Review and create tags as necessary to support search
First heading (H2)
Always use heading levels in order to enhance the experience for those using screen readers.
Subheading (H3)
NOTE
Style Guide - Inclusive Language
Language is inclusive when it doesn’t exclude anyone based on characteristics such as gender, physical or mental disability, or cultural background. By using inclusive language, you can make your content more accessible and show respect to the widest possible audience.
Sample ways to make writing more inclusive:
- Using person-first language (“people with disabilities” instead of “disabled people”).
- Using they/their instead of him/his/her/hers, or rewriting sentences to avoid gender-specific pronouns.
There are additional ways to make your writing more inclusive.
Avoid Assuming Ability
Part of accessibility is recognizing that our website users have different abilities. For example, we make sure that our websites are navigable using a keyboard alone, to accommodate those who don’t use a mouse. We also need to be conscious of what we assume about a user’s ability when it comes to the language we choose.
Using vision-related words such as “see" and “watch” (i.e., see the schedule) implies that the person is accessing the content with their eyes. However, our audience includes people with vision impairments who access our website in non-visual ways using assistive technology. To be more inclusive, consider using alternatives to vision-related words in links and other content.
Here are some alternatives to try:
- Access (Access the schedule)
- Check out (Check out the current job openings)
- Learn about (Learn about student resources)
- Experience (Experience the webinar)
- Catch up on (Catch up on the latest videos)
- Explore (Explore the upcoming events)
Avoid Assuming Cultural Background
It’s also important to use language that avoids assumptions about someone’s cultural background. Expressions that convey meaning using a cultural reference, such as “I’m looking for a ballpark figure,” are used in many U.S. workplaces. But they can be confusing to people from other cultures or whose first language isn’t English. Someone not familiar with the reference (baseball, in our example) might not understand what the expression means.
You can make your writing more inclusive by avoiding the use of jargon, metaphors and idioms. By using plain language, you can make your meaning clear to the widest possible audience.
Resources
These resources can help you learn about inclusive language: