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.

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

Define inclusive guidelines #31

Open
3 tasks
ExperimentsInHonesty opened this issue Nov 27, 2021 · 4 comments
Open
3 tasks

Define inclusive guidelines #31

ExperimentsInHonesty opened this issue Nov 27, 2021 · 4 comments
Assignees
Labels
0.1-Status: Setup Epic Epic: Confirming no conflicting issues, setting up folders TG: Gather Examples Gather examples from existing projects

Comments

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Nov 27, 2021

Overview

We want our guides to be as inclusive as possible, with language that translates to screen readers well.

Action Items

  • Identify common wording
  • examples of common wording
  • replacement structures

Resources/Instructions

Decision was made to use the following formatting (Bold, Quotes and Itallics):

  • Text or buttons that should be clicked/selected (e.g., Sign-In)
    • Choose the Confirm button.
  • Text that the user enters word-for-word (e.g., user is instructed to enter xyz into this field)
    • Enter "/Remind" into the field
  • Text that refers to something on the page
    • Their name and email will appear in the Waiting to be Confirmed header.
@ExperimentsInHonesty ExperimentsInHonesty added 0.1-Status: Setup Epic Epic: Confirming no conflicting issues, setting up folders TG: Gather Examples Gather examples from existing projects labels Nov 27, 2021
@ExperimentsInHonesty
Copy link
Member Author

ExperimentsInHonesty commented Nov 27, 2021

Wording choices examples

  • Original: click on
    • Head to 1password.com/ and click on Sign In on the top-right hand side. Choose the Hack for LA account. Sign in to the account using your credentials.
  • Proposed change:
    • Head to 1password.com/ and choose Sign in. [insert screenshot here]
  • Original: right-hand side
    • Step 2: Navigate to Vaults
      On the right-hand side of 1Password, click on Vaults.
  • Proposed change:
    • Choose Vaults from the navigation panel.
  • Original: click on
    • Search vault for the appropriate project title, and click on the project name link. For this example we will be using 100 Automations.
  • Proposed: indicates where they should search and separates concerns
    • Use the Search Vaults input box to find the appropriate project title. For this example, we will be using 100 Automations, you will be searching for the name of your project.
      [insert screenshot]
    • select the name of your project.
      [insert screenshot]

@kcoronel
Copy link
Member

Original: user should see

@ExperimentsInHonesty
Copy link
Member Author

ExperimentsInHonesty commented Dec 18, 2021

  • walk you through should be replaced with take you
  • copy and paste the message below can be replaced with You can use the message below
  • next to their name can be replaced with for their name
  • disappears from the page can be replaced with closes
  • will appear can be replace with will be in

@kcoronel
Copy link
Member

"Follow the steps listed below" should be replaced to "use the steps that follow"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0.1-Status: Setup Epic Epic: Confirming no conflicting issues, setting up folders TG: Gather Examples Gather examples from existing projects
Projects
Status: Properly Labeled and not yet ready for Guides Team Review
Development

No branches or pull requests

2 participants