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

Cleaning up a lot of little link errors #741

Merged
merged 17 commits into from
Mar 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 _guide/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ Worldwide, government website design is being led by open source initiatives.
* [Okta's Odyssey Design System](https://github.com/okta/odyssey)
* [IBM's Carbon open source design system](https://www.carbondesignsystem.com/) - [Carbon on GitHub](https://github.com/carbon-design-system/carbon) [Carbon's Accessibility](https://www.carbondesignsystem.com/guidelines/accessibility/overview/) - Uses Web Components
* [Impact Design System](https://demos.creative-tim.com/impact-design-system/index.html) - [Impact Desigh System on GitHub](https://github.com/creativetimofficial/impact-design-system)
* [VMWare's Clarity Design System](https://clarity.design/) - [Clarity on GitHub](https://github.com/vmware/clarity) [Clarity's Accessibility](https://clarity.design/get-started/support/#accessibility-support) - Uses Web Components
* [VMWare's Clarity Design System](https://clarity.design/) - [Clarity on GitHub](https://github.com/vmware/clarity) [Clarity's Accessibility](https://clarity.design/get-started/support/) - Uses Web Components
* [Emulsify](https://www.emulsify.info/) - [Emulsify on GitHub](https://github.com/emulsify-ds) [Emulsify's Accessibility](https://docs.emulsify.info/usage/accessibility-testing)
* [ING's Lion Design System](https://lion-web-components.netlify.app/?path=/story/*) - [Lion on GitHub](https://github.com/ing-bank/lion) [Lion's Accessibility](https://lion-web.netlify.app/blog/ing-open-sources-lion/#accessibility) - Uses Web Components
* [Talend's Coral Design System](https://design.talend.com/) - [Coral on GitHub](https://github.com/Talend/ui/) - Uses React Components
* [Orange Digital Accessibility](https://a11y-guidelines.orange.com/en/) - [Orange a11y-guidelines on GitHub](https://github.com/Orange-OpenSource/a11y-guidelines)
* [Google's Material Design](https://material.io/) - [Material on GitHub](https://github.com/material-components) [Material's Accessibility](https://material.io/design/usability/accessibility.html#understanding-accessibility) - Uses Web Components
* [Google's Material Design](https://material.io/) - [Material on GitHub](https://github.com/material-components) [Material's Accessibility](https://material.io/design/usability/accessibility.html) - Uses Web Components
* [Adobe's Spectrum](https://spectrum.adobe.com/) - [Spectrum's Inclusive Design](https://spectrum.adobe.com/page/inclusive-design/) - Uses Web Components
* [Microsoft's Fluent](https://www.microsoft.com/design/fluent/#/) [Fluent UI on GitHub](https://github.com/microsoft/fluentui)
* [Microsoft's Fluent](https://www.microsoft.com/design/fluent/) [Fluent UI on GitHub](https://github.com/microsoft/fluentui)
* [Bridge Lab's Bold](https://bold.bridge.ufsc.br/en/) - [Bold on GitHub](https://github.com/laboratoriobridge/bold) [Bold's Accessibility](https://bold.bridge.ufsc.br/en/design-guidelines/accessibility/)
* [Shopify's Polaris](https://polaris.shopify.com/) - [Polaris on GitHub](https://github.com/topics/shopify-polaris) [Polaris' Accessibility](https://polaris.shopify.com/foundations/accessibility)
* [Intuit's Design-systems-cli](https://intuit.github.io/design-systems-cli/) - [Intuit on GitHub](https://github.com/intuit/design-systems-cli) [Quickbooks' Accessibility](https://designsystem.quickbooks.com/bolt/accessibility/)
Expand Down
14 changes: 7 additions & 7 deletions _guide/plain-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ roles:

## Overview

You worked hard getting your content online. How do you make sure your readers can find, understand and use it? Apply plain language. Clear and direct writing makes your content [accessible](https://www.w3.org/WAI/WCAG21/Understanding/reading-level.html) (it's also the [law](https://www.plainlanguage.gov/law/)!). Plain language also helps people with different cognitive abilities. Or speakers of a non-English language. Or those who rely on audio to listen to text.
You worked hard getting your content online. How do you make sure your readers can find, understand and use it? Apply plain language. Clear and direct writing makes your content [accessible](https://www.w3.org/WAI/WCAG21/Understanding/reading-level.html) (it's also the [law](https://www.plainlanguage.gov/law/)!). Plain language also helps people with different cognitive abilities. Or speakers of a non-English language. Or those who rely on audio to listen to text.
You might also be writing for the public. Or a group of experts. Either way, your audience's reading level is likely [lower than you think](https://literacyproj.org/).

## Who this is for
Expand All @@ -35,7 +35,7 @@ You might also be writing for the public. Or a group of experts. Either way, you

Avoid:

* Jargon and government legalese. If you have to use an acronym, spell it out first.
* Jargon and government legalese. If you have to use an acronym, spell it out first.
* Filler words. For example, use the word 'analyze' not 'conduct an analysis'.
* Repetitive words
* Irony or idioms
Expand All @@ -54,7 +54,7 @@ Before writing, ask yourself: What are your reader's needs? What do they need to

### Make it actionable

People visit your website to do something: answer a question or complete a specific task. Ask yourself: what are the top questions my target reader wants to know? How can I answer it quickly?
People visit your website to do something: answer a question or complete a specific task. Ask yourself: what are the top questions my target reader wants to know? How can I answer it quickly?

### Choose words your reader uses

Expand All @@ -68,7 +68,7 @@ Use bulleted lists to make content easy to scan. Remember: website users don't r

### Test your content with a readability tool

Always run your content through a readability tool. You can use [Hemingway App](http://www.hemingwayapp.com/), [Readable.io](https://readable.io/), or [turn on Flesch-Kincaid](https://support.microsoft.com/en-us/topic/get-your-document-s-readability-and-level-statistics-85b4969e-e80a-4777-8dd3-f7fc3c8b3fd2) if editing in Microsoft Word. Try to get the reading grade level lower than 8th grade. Before using the tool, remember to remove:
Always run your content through a readability tool. You can use [Hemingway App](https://www.hemingwayapp.com/), [Readable.io](https://readable.io/), or [turn on Flesch-Kincaid](https://support.microsoft.com/en-us/topic/get-your-document-s-readability-and-level-statistics-85b4969e-e80a-4777-8dd3-f7fc3c8b3fd2) if editing in Microsoft Word. Try to get the reading grade level lower than 8th grade. Before using the tool, remember to remove:

* proper nouns
* titles
Expand All @@ -88,11 +88,11 @@ Automated readability tools won't catch everything. You'll need to test your con

* [Menu labels](https://www.nngroup.com/articles/tree-testing/) and micro-content. Keep your [user goals](https://www.nngroup.com/articles/task-scenarios-usability-testing/) in mind.
* Language. Ask your users to read your content out loud. What words do they stumble over? How do they rate the clarity of the language (on a scale from 1 to 5)?
* Understanding. Ask your users to paraphrase what they read. What did they summarize correctly? What did they miss? What did they get wrong?
* Understanding. Ask your users to paraphrase what they read. What did they summarize correctly? What did they miss? What did they get wrong?

## Join a plain language community

* [Digital.gov Plain Language Action and Information Network](https://digital.gov/communities/plain-language/). They promote plain language in all government communications.
* [Digital.gov Plain Language Action and Information Network](https://digital.gov/communities/plain-language/). They promote plain language in all government communications.
* [Plain Language Association International LinkedIn](https://www.linkedin.com/groups/158634/). This group advocates for plain language in business, government, and law.

## Find a plain language tool
Expand All @@ -104,7 +104,7 @@ Automated readability tools won't catch everything. You'll need to test your con

## Get trained in plain language

The Center for Plain Language offers training for federal employees. You can take:
The Center for Plain Language offers training for federal employees. You can take:

* An [introductory class](https://www.plainlanguage.gov/training/introductory-classes/) to plain language
* A [bootcamp class](https://www.plainlanguage.gov/training/train-the-trainer-bootcamp/) to become a plain language trainer at your organization
Expand Down
4 changes: 2 additions & 2 deletions _guide/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ General and digital-specific accessibility books we recommend.
* [Agile Accessibility Explained](https://www.amazon.com/Agile-Accessibility-Explained-sustainable-development/dp/1689182733/ref=sr_1_2?dchild=1&keywords=Agile+Accessibility+Explained&qid=1615337578&sr=8-2) Dylan Anthony Barrell
* [Design for Real Life](https://abookapart.com/products/design-for-real-life) - Sara Wachter-Boettcher and Eric Meyer
* [Designing Connected Content: Plan and Model Digital Products for Today and Tomorrow](https://www.amazon.com/Designing-Connected-Content-Products-Tomorrow/dp/0134763386) - Mike Atherton
* [End of Average](http://www.toddrose.com/endofaverage) - Todd Rose
* [End of Average](https://www.toddrose.com/endofaverage) - Todd Rose
* [Inclusive Design for a Digital World: Designing with Accessibility in Mind](https://www.amazon.com/Inclusive-Design-Digital-World-Accessibility/dp/148425015X) - Regine M. Gilbert
* [Inclusive Design Patterns](https://www.amazon.com/Inclusive-Design-Patterns-Heydon-Pickering-ebook/dp/B01MAXK8XR) - Heydon Pickering
* [Mismatch: How Inclusion Shapes Design](https://mitpress.mit.edu/books/mismatch) - Kat Holmes
Expand All @@ -42,7 +42,7 @@ General and digital-specific accessibility books we recommend.
* [A11yweekly.com](https://a11yweekly.com/) by David A. Kennedy
* [Accessibility Matters Newsletter](https://www.accessibilityassociation.org/content.asp?contentid=167) - by the IAAP
* [Microassist's Accessibility in the News](https://www.microassist.com/digital-access/news/) - by Jack McElaney
* More available from [WebAxe who maintains a terrific list](http://www.webaxe.org/digital-accessibility-newsletters/)
* More available from [WebAxe who maintains a terrific list](https://www.webaxe.org/digital-accessibility-newsletters/)


## Podcasts {#podcasts}
Expand Down
16 changes: 7 additions & 9 deletions _guide/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Digital accessibility tools.

## Authoring {#authoring}

* [A11yFirst for CKEditor](http://a11yfirst.web.illinois.edu/) - [Accessibility First on GitHub](https://github.com/a11yfirst/distribution) \
* [A11yFirst for CKEditor](https://a11yfirst.web.illinois.edu/) - [Accessibility First on GitHub](https://github.com/a11yfirst/distribution) \
Series of plugins for supporting a11y best practices within the WYSIWYG editor, CKEditor.
* [Sa11y, the accessibility quality
assurance assistant](https://sa11y.netlify.app/) \
Expand All @@ -26,7 +26,7 @@ A plugin for [retext](https://github.com/retext-project/retext) that scans text
Another plugin for [retext](https://github.com/retext-project/retext) that checks text content for possible insensitive, inconsiderate language.
* [Zettlr: Markdown Editor](https://www.zettlr.com/) - [Zettlr on GitHub](https://github.com/Zettlr/Zettlr) \
Open source Markdown editor that simplifies the content creation experience by avoiding the clutter seen in many common word processing solutions.
* [Drupal](http://drupal.org/) is a very accessible CMS and [these modules can enhance its accessibility](https://accessibility.civicactions.com/guide/resources#drupal-accessibility-modules)
* [Drupal](https://drupal.org/) is a very accessible CMS and [these modules can enhance its accessibility](https://accessibility.civicactions.com/guide/resources#drupal-accessibility-modules)
* [ATOM Plugin - web-accessibility-checker package](https://atom.io/packages/web-accessibility-checker) An accessibility \
Plugin for the popular open source ATOM Editor from GitHub.

Expand Down Expand Up @@ -77,11 +77,11 @@ This tool runs a set of tests against a set of URLs to verify whether each one m
Extremely flexible and popular testing suite from Google that can be run directly on pages, from the command line, or as a Node module.
* [IBM Equal Access Toolkit](https://www.ibm.com/able/toolkit/) - [equal-access on GitHub](https://github.com/IBMa/equal-access) \
Tools from IBM that can automate accessibility testing from a browser, or when added to a continuous integration environment.
* [Explore ARIA Landmarks Browser Extension](http://matatk.agrip.org.uk/landmarks/) - [Landmarks on GitHub](https://github.com/matatk/landmarks) \
* [Explore ARIA Landmarks Browser Extension](https://matatk.agrip.org.uk/landmarks/) - [Landmarks on GitHub](https://github.com/matatk/landmarks) \
Browser extension that allows you to navigate a web page via WAI-ARIA landmarks, using the keyboard or a pop-up menu.
* [Firefox AInspector WCAG](https://addons.mozilla.org/en-US/firefox/addon/ainspector-wcag/) - A Firefox Add-on that addresses accessibility compliance \
using OpenAjax Alliance rulesets.
* [Qualweb](http://qualweb.di.fc.ul.pt/evaluator/) - [Qualweb on GitHub](https://github.com/qualweb) - A set of tools that are being built to align with the W3C's ACT ruleset.
* [Qualweb](https://qualweb.di.fc.ul.pt/evaluator/) - [Qualweb on GitHub](https://github.com/qualweb) - A set of tools that are being built to align with the W3C's ACT ruleset.

## Bookmarklets {#bookmarklets}

Expand All @@ -108,9 +108,9 @@ Evaluate WAI-ARIA according to the [ARIA in HTML](https://www.w3.org/TR/html-ari
* [Contrast Finder by Tanaguru](https://contrast-finder.tanaguru.com/) - [Contrast Finder GitHub Page](https://github.com/Tanaguru/Contrast-Finder)
* [Contrast-Ratio.com](https://contrast-Ratio.com) - [Contrast-Ratio GitHub Page](https://github.com/siege-media/contrast-ratio) \
Allows for testing of contrast of text on top of a semi transparent background.
* [Contrast Checker](https://contrast-checker.glitch.me/) - [Contrast Checker on Glitch](https://glitch.com/edit/#!/contrast-checker?path=server.js%3A1%3A0)
dmundra marked this conversation as resolved.
Show resolved Hide resolved
* [Contrast Checker](https://contrast-checker.netlify.app/)
* [ButtonBuddy](https://buttonbuddy.dev/) - [ButtonBuddy on GitHub](https://github.com/5t3ph/buttonbuddy)
* [ACD (Previously ColorCube)](http://accessiblecolor.design) - [ColorCube on GitHub](https://github.com/oomphinc/colorcube)
* [ACD (Previously ColorCube)](https://accessiblecolor.design) - [ColorCube on GitHub](https://github.com/oomphinc/colorcube)
* [LeonardoColor.io](https://leonardocolor.io/#) - [Leonardo on GitHub](https://github.com/adobe/leonardo)
* [Colour Contrast Checker](https://colourcontrast.cc) - [Colour Contrast Checker on GitHub](https://github.com/Pushedskydiver/Colour-Contrast-Checker)
* [Who Can Use](https://whocanuse.com/) - [Who Can Use on GitHub](https://github.com/CoreyGinnivan/whocanuse)
Expand Down Expand Up @@ -169,13 +169,11 @@ Testing with [Nightwatch](https://nightwatchjs.org/) on GitHub
Simulates color blindness, low vision, dyslexia and more.
* [Funkify Chrome Extension](https://www.funkify.org/) \
Not open source, but a free version is available which simulates dyslexia and cognitive/motor/vision conditions.
* [ChromeLens Extension](http://chromelens.xyz/) - [ChromeLens on GitHub](https://github.com/chromelens/chromelens) \
Chrome extension that offers vision simulators, testing, and a tab focus order visualizer.
* [Sim Daltonism](https://michelf.ca/projects/sim-daltonism/) - [sim-daltonism on GitHub](https://github.com/michelf/sim-daltonism/) \
iOS/Mac app that lets you visualize colors as they are perceived with various types of color blindness.
* [A11Y: Color blindness empathy test](https://vinceumo.github.io/A11Y-Color-Blindness-Empathy-Test/) [on GitHub](https://github.com/vinceumo/A11Y-Color-Blindness-Empathy-Test-browser-extensions)
Chrome/Firefox extension and a web-based tool created to help designers and developers better understand color blindness and visual imparity.
* [Color Oracle](http://colororacle.org/) - [Oracle-Mac on GitHub](https://github.com/nvkelso/color-oracle) & [Oracle-Windows on GitHub](https://github.com/nvkelso/color-oracle-java) \
* [Color Oracle](https://colororacle.org/) - [Oracle-Mac on GitHub](https://github.com/nvkelso/color-oracle) & [Oracle-Windows on GitHub](https://github.com/nvkelso/color-oracle-java) \
Color blindness simulator for Windows, Mac, and Linux.

## EPUB3 {#epub}
Expand Down
2 changes: 1 addition & 1 deletion _playbook/automated-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Government Digital Services in both the [United Kingdom](https://github.com/alph
However, it is important to note that, no matter the tool, [automated testing only catches about one third of accessibility issues](https://alphagov.github.io/accessibility-tool-audit/), so it cannot be relied upon to determine if a site complies. To better ensure that their digital tools are accessible to keyboard-only and assistive technology users, automated tests need to be done along with a robust manual testing plan.

List of popular automated testing tools
* [Wave](http://wave.webaim.org/extension/)
* [Wave](https://wave.webaim.org/extension/)
* [Tenon](https://tenon.io/)
* [SiteImprove](https://chrome.google.com/webstore/detail/siteimprove-browser-exten/amoojkmllfodlpgmdnclkgdnejgpeada)
* [See more tools in our guide](/guide/tools)
Expand Down
4 changes: 2 additions & 2 deletions _playbook/checklists.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ One could also look to use a tool like WebAim's WAVE, ANDI, or Tota11y to scan a
* See if the alt text effectively describes the images on the page.
* Ensure that there is sufficient color contrast.
* Do keyboard only testing (using just tab, shift-tab, arrow keys & escape) to navigate the page.
* Evaluate page for plain language using free tools like the [HemingwayApp](http://www.hemingwayapp.com/).
* Evaluate page for plain language using free tools like the [HemingwayApp](https://www.hemingwayapp.com/).
* Magnify the page up to 200% and look for usability and readability issues.

There are lots of checklists, rotating through a few of them will help give different people different things to think about accessibility:
Expand All @@ -43,7 +43,7 @@ There are lots of checklists, rotating through a few of them will help give diff
* [Elsevier's WCAG 2.1 Checklist](https://romeo.elsevier.com/accessibility_checklist/)
* [A11yProject](https://www.a11yproject.com/checklist/)
* [Heydon Works](https://github.com/Heydon/inclusive-design-checklist)
* [VoxMedia](http://accessibility.voxmedia.com/)
* [VoxMedia](https://accessibility.voxmedia.com/)
* [PSU](https://accessibility.psu.edu/checklist/)
* [Yale](https://usability.yale.edu/web-accessibility/articles/wcag2-checklist)
* [University of Washington](https://www.washington.edu/accessibility/checklist/)
Expand Down
2 changes: 1 addition & 1 deletion _playbook/roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ We've taken these lists, added other roles that we didn't see included and inclu
## Content Author / Writer
* See: [USA: Accessibility for content designers](https://accessibility.digital.gov/content-design/getting-started/)
* W3C WAI - [ARRM Project: Accessibility Roles and Responsibilities Mapping](https://www.w3.org/WAI/EO/wiki/Content_Author_Responsibilities_Mapping).
* **Tools:** [Sa11y](https://ryersondmp.github.io/sa11y/), [Editoria11y](https://itmaybejj.github.io/editoria11y/), [retextjs](https://github.com/retextjs) and [HemingwayApp](http://www.hemingwayapp.com/)
* **Tools:** [Sa11y](https://ryersondmp.github.io/sa11y/), [Editoria11y](https://itmaybejj.github.io/editoria11y/), [retextjs](https://github.com/retextjs) and [HemingwayApp](https://www.hemingwayapp.com/)
* Checklist:
* Does the content meet your readability target?
* Are there any [unusual words](https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#unusual-words) to watch for?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,4 @@ You should keep tweaking the tools and double-check your content to make sure it
* [Readability Check](https://marketplace.visualstudio.com/items?itemName=jemcclin.readabilitycheck).
* [status-stats-jbrains package](https://atom.io/packages/status-stats-jbrains).

Thank you to [Michelle Kang](/about/people/michelle-kang), [Marlena Medford](https://civicactions.com/team/marlena-medford), [Luke Fretwell](/about/people/luke-fretwell), and [Mike Gifford](/about/people/mike-gifford) for your support, thoughts, and feedback.
Thank you to Michelle Kang, Marlena Medford, Luke Fretwell, and Mike Gifford for your support, thoughts, and feedback.
Loading
Loading