Skip to content

Commit

Permalink
docs: add initial outline of a11y guides
Browse files Browse the repository at this point in the history
  • Loading branch information
sh0ji committed Sep 24, 2024
1 parent 50b34b1 commit 423f559
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 0 deletions.
17 changes: 17 additions & 0 deletions website/docs/guides/accessibility/01-accessible-content.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Accessible content
description: Guidelines for text, images, and video.
id: accessible-content
tags: [accessibility, screen reader]
draft: true
---

:::warning Work in progress
This guide will cover the absolute basics of accessible content.

- Image descriptions ("alt text")
- Captions for videos
- Video descriptions
- Readability (text accessibility)
:::

15 changes: 15 additions & 0 deletions website/docs/guides/accessibility/02-cognitive-load.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Cognitive load
description: Designing around the constraints of our brain power.
tags: [accessibility, cognitive load]
draft: true
---

:::warning Work in progress
This guide will give a high-level overview of what cognitive load is and provide some tips for using it as a design constraint.

- Designing around working memory
- Reducing extraneous cognitive load - this should cover the concept of germane/extraneous cognitive load
- Just in time - how "just in time" design helps reduce cognitive load
:::

16 changes: 16 additions & 0 deletions website/docs/guides/accessibility/03-managing-focus.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Managing focus
description: How to think about keyboard interactions
tags: [accessibility, focus]
draft: true
---

:::warning Work in progress
This guide will cover focus management and keyboard interactions more generally.

- The purpose of the focus indicator, as well as how NDS has designed it.
- What can we focus? - clarification that only interactive elements can/should be focused. Principles for thinking about this.
- Who uses focus? - focus is used by everyone but required by some.
- Focus order - how to think about designing the focus order/layout of your page.
:::

15 changes: 15 additions & 0 deletions website/docs/guides/accessibility/04-dynamic-content.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Managing dynamic content
description: Principles and tips for ensuring that dynamic content is accessible.
tags: [accessibility, screen reader]
draft: true
---

:::warning Work in progress
This guide will cover how to design content that changes on the page.

- How screen reader users experience content changes
- Principles: notify users about changes, don't move focus, and only change one thing at a time
- Gestalt principles?
:::

0 comments on commit 423f559

Please sign in to comment.