nextcloud / nextcloud/documentation

Accessibility subsite in Design documentation

Open
#788 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2. developing design enhancement help wanted manual: developer
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

Accessibility

We track all issues and enhancements regarding accessibility with the feature: accessibility label. They are also all part of the design label.

The posters on dos and don'ts on designing for accessibility are a great summary. Print out the PDF and hang them up. :)

Screenreader accessibility

Keyboard navigation

  • It should be easy to visually determine the element with keyboard focus. To test, simply use Tab ↹ and make sure all elements are highlighted. Whenever you use :hover in your CSS, also include :focus and :active.
  • All elements that can be interacted with via a mouse click should also be possible to interact with via pressing Enter ↵.
  • Also see: Quick Test: Navigate using just your keyboard

Contrast and legibility

Comprehension

  • Write in simple and understandable language.
  • Don’t use technical jargon which needs prior knowledge. (Like 404 Error, or Couldn’t set variable X) You can do that in the console to help debugging, but don’t show it in the interface.
  • Check your written text using comprehension check tools.

Testing tools

We use various tools for testing like:

Recommended reading

@nextcloud/accessibility @nextcloud/designers @MarcoZehe @tyrylu @skjnldsv @kevgathuku @juliushaertl what are additional points we should list? :) I’m wondering how much general accessibility info we should list or rather link to.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Accessibility section in the Design documentation and review the guidance and external links already listed in the issue. Clarify with maintainers which additional accessibility points belong here versus which should remain external references; done means an agreed scope and an updated, focused section.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.