Skip to content

Define inclusive guidelines #31

Open

Description

@ExperimentsInHonesty

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.

Activity

  1. ExperimentsInHonesty commented on Nov 27, 2021

    @ExperimentsInHonesty
    MemberAuthor

    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]
  2. kcoronel commented on Dec 18, 2021

    @kcoronel
    Member

    Original: user should see

  3. ExperimentsInHonesty commented on Dec 18, 2021

    @ExperimentsInHonesty
    MemberAuthor
    • 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
  4. kcoronel commented on Jan 29, 2022

    @kcoronel
    Member

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

  5. moved this to Properly Labeled and not yet ready for Guides Team Review in P: Guides: Tracker of guide issues (in knowlegebase-content repo)on May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

0.1-Status: Setup EpicEpic: Confirming no conflicting issues, setting up foldersTG: Gather ExamplesGather examples from existing projects

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions