Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): minor UX Writing Guide copy to match Dev Center IA conventions #1334

Merged
merged 3 commits into from
Jan 31, 2024
Merged

fix(docs): minor UX Writing Guide copy to match Dev Center IA conventions #1334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e972dd5
upcase titles, change UX writing guide to UX Content Guide
Jan 23, 2024
03f79f0
Move back to UX Writing Guide, title case titles
Jan 30, 2024
a604167
Merge branch 'main' into ux-content-guide
Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/docs/design-docs/ux-writing/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import CardGrid from '@components/Card/CardGrid';
import LandingCard from '@components/Card/LandingCard';
import Icon from '@components/icons/Icon';

# UX writing guide
# UX Writing Guide

<CardGrid>
<LandingCard
Expand All @@ -23,9 +23,9 @@ import Icon from '@components/icons/Icon';
/>
</CardGrid>

The purpose of the **BigCommerce UX writing guide** is to present a consistent, coherent and competent voice to BigCommerce merchants and their shoppers as it relates to in-product, customer-facing communication, aka microcopy.
The purpose of the **BigCommerce UX Writing Guide** is to present a consistent, coherent and competent voice to BigCommerce merchants and their shoppers as it relates to in-product, customer-facing communication, aka microcopy.

Writers, researchers, designers and developers, both internal and external, who have a hand in designing BigCommerce products can refer to this guide anytime there’s a question about the writing.
Writers, researchers, designers and developers, both internal and external, who have a hand in designing BigCommerce products can refer to this guide anytime there’s a question about UX writing.

- Not sure if you need a period at the end of a heading?

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/design-docs/ux-writing/status-messages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Donts, Dos } from '@components/big-design/DosAndDonts';

# Status messages
# Status Messages

Status messages help the user to understand what is happening in the application. Their common instances are success, warning and error messages.

Expand Down
4 changes: 2 additions & 2 deletions packages/docs/design-docs/ux-writing/the-basics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { ComparisonTable } from '@components/big-design/ComparisonTable';
import { Donts, Dos, DosAndDonts } from '@components/big-design/DosAndDonts';
import Icon from '@components/icons/Icon';

# The basics
# The Basics

## Voice and tone

Expand Down Expand Up @@ -70,7 +70,7 @@ Merchants who use BigCommerce come from a wide range of different social and eth

The language we use inside our products should take into account the diversity of our users. To that end, communicate in such a way that is inclusive, being careful to avoid culturally ingrained biases that, actively or passively, exclude certain groups.

The goal of this section of the UX writing guide is to give you a quick gloss on how to remove non-inclusive terms and phrases from the discourse of ecommerce.
The goal of this section of the UX Writing Guide is to give you a quick gloss on how to remove non-inclusive terms and phrases from the discourse of ecommerce.

### What is inclusive language?

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/design-docs/ux-writing/writing-for-mobile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Writing for mobile
# Writing for Mobile

When writing for the mobile app:

Expand Down