Giter VIP home page Giter VIP logo

dwp / accessibility-manual Goto Github PK

View Code? Open in Web Editor NEW
38.0 15.0 16.0 9.16 MB

The DWP Accessibility Manual is a community led effort to put guidance and best practices all in one place for anybody looking to meet the Public Sector Bodies Accessibility Regulations 2018.

Home Page: https://accessibility-manual.dwp.gov.uk

License: MIT License

JavaScript 3.06% SCSS 0.85% HTML 93.25% Nunjucks 2.84% Procfile 0.01%
accessibility gov dwp

accessibility-manual's People

Contributors

36degrees avatar abbott567 avatar brianteeman avatar edent avatar finnberry avatar gstevenson avatar hidde avatar htmlandbacon avatar mgifford avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

accessibility-manual's Issues

Resize text

There is nothing in the guidance for your job role about the use of REM and EM for font sizes and WCAG 1.4.4 Resize Text

Simplify content

A lot of the content was written quickly and could be simplified using Hemingway App

Redo screenshots for Arc, Axe and Wave.

The yellow highlight looks too much like the focus indicator. There will be a better way to highlight the areas of interest on the images in a way where they don't look like they have the keyboard focus.

We'd like to collaborate with you!

Hi there,
I'm from the Digital Accessibility in Learning team from the Canada School of Public Service (a Canadian Department) specialized in creating and delivering learning products. We're currently revamping our accessibility section in our Playbook and we'd like to collaborate with you.

Let us know if it's something possible!

Thanks,
Myriam Lamontagne
Senior Instructional Designer in Digital Accessibility
UX Division
Canada School of Public Service / Government of Canada
[email protected]

Weird line breaks

As seen on https://www.accessibilitymanual.com/accessibility-law/the-public-sector-bodies-accessibility-regulations-2018
An unnatural linebreak in a sentence

I suspect your Markdown to HTML parser is treating every \n as a linebreak. The HTML it produces is:

<p>Sometimes there is confusion between what is a website or a computer programme.
<br>
For the purposes of the legislation, a website is anything which runs in
<br>
a web browser.</p>

Files affected: https://github.com/dwp/accessibility-manual/search?q=for+the+purposes+of+legislation

Digital Accessibility Specialist Role

On 30 August the digital accessibility specialist role was added to the DDat profession.

Could this please be added to the manual please, happy to assist in adding content for the relevant pages of the manual.

Best,
Adam

Please note - this is my first interaction with GitHub so I apologise in advance if this is out of place.

incorrect link for content designer on designing screens page

https://accessibility-manual.dwp.gov.uk/best-practice/designing-screens

two links (at bottom of page)

  • interaction designer
  • content designer

Both links go to interaction designer advice. ie. content design link is incorrect.
Looks like content designer link should be: https://accessibility-manual.dwp.gov.uk/guidance-for-your-job-role/content-designer
As i can navigate to that page by changing the Url, or find that link elsewhere on the site.

The site is great but the way. Just used it to help a couple of colleagues out - show that the law means internal systems have to be accessible and publish an accessibility statement.
I'm telling people this is the de-facto site for Gov accessibility advice.

Color Contrast

I love WebAim. They are great. No problem with you promoting their terrific work:
https://accessibility.civicactions.com/guide/tools#quick-tests

That said, we're promoting two other tools for color contrast because they are open source:
https://accessibility-manual.dwp.gov.uk/tools-and-resources/manual-accessibility-testing

The other big advantage of https://contrast-ratio.com/ is that it can take more than HEX values. HSLA works well in the web & transparencies are increasingly important.

WCAG AA and AAA - WCAG 2.0 & 2.1

I am looking at https://accessibility-manual.dwp.gov.uk/best-practice/wcag-aa-and-aaa

And I'm not sure that's the right approach. I think at this point it is useful talking about WCAG 2.0, 2.1, 2.2 & 3.0.

It isn't clear from this document that WCAG 2.0 requirements are included in WCAG 2.1 (but they are).

AAA should be aspirational, and AA the legal floor. Every government site should be AA, and depending on the audience of the site it may be important to prioritize which AAA criteria a department strives to achieve. You kind of get to this in the document but to meet WCAG AA, all WCAG A requirements need to be fulfilled.

This might be accurate:

Some of the impacts of making your service AAA will involve changing how a user interacts with your service and will go against security and GDS patterns, however, some will be fulfilled by default.

But folks seeing this will just stop reading any further. If there are specifics about AAA requirements that go against GDS & security best practices, be specific. There should be an issue queue somewhere to track current best practices to addressing this.

I'm not sure this is the best way to express this either:

We have a legal requirement to meet AA, however to meet AAA we have to meet every single one of the WCAG 2.1 criteria.

I don't think a government website exists that can claim to be AAA compliant. Certainly the W3C isn't. Being WCAG 2.x AAA compliant is next to impossible, and considerably increases the costs of building and maintaining a site. Not that those aren't worth striving for, but nobody should be talking about AAA compliance, as it doesn't really exist.

Incorrect links for basic accessibility checks

Align content with GDS review

GDS plan to review the content in the manual and the content on GOV.UK just to make sure everything is aligned. Once the review is completed I will schedule in any updates.

Title content should align

Unlike in the software engineering section, the content design section it doesn't mention the page title format:
page title - service name - gov.uk

This is because it was assumed that the content designer would need to title the pages, and the service name, but the software engineer would have to configure the title format in the layout.

However, on reflection, it should probably be called out in both sections so it's consistent and incase it gets missed.

Document structure improvements

This page - https://accessibility-manual.dwp.gov.uk/best-practice/document-structure - like the rest of the manual contains some really great stuff. Lots to build on and learn from.

Language

Could be improved by explaining about the language of parts. It is a bit technical here, and many WYSIWYG editors may not have an easy way to insert a language attribute into it. We have built it into Drupal, but even there it isn't enabled by default, and not something that a generic editor can enable. More examples here will be useful, as most folks won't know how to hard code the HTML for Je Ne Sais Quoi. This isn't something that people are trained to do in my experience:

If you have more than one language in your document, for example you have an English document which contains a French quote, then you should make sure you set the language correctly for each part.

It is common to say, "You should try to write in plain English and for a reading age of 9." but if you put the line above into https://hemingwayapp.com/ it shows as Grade 14. We all do this. Plain English is hard to write. It is important to have some automated process to check.

I also like to remind folks that we're writing for real world situations. People are reading work email after have a drink or two with friends at the pub, while on their cell phone. We can't assume that people reading this content are at the top of their game and have already have their 2nd cup of coffee in the morning. Real world, especially in a pandemic, is more complicated than that.

It was unclear to me what type of documents you were writing..

The only office tool I know that has accessibility checkers built-in is the one from Microsoft, so you might as well say that. If government uses other software that has it, it would be good to include it.

Also, on PDFs, can you be clear and consistent and tell people not to? We know they will do it anyways, but ya, a warning like this one would be good.

Plus, why not link to the great work over here https://www.gov.uk/guidance/publishing-accessible-documents

Assitive technology testing - several improvements

The page here:
https://accessibility-manual.dwp.gov.uk/best-practice/assistive-technology-testing

should have a title of (missing an 's):
Assistive technology testing

I think i've you'd been using tools like this that spelling error would be caught:
https://accessibility.civicactions.com/posts/how-we-scale-inclusive-website-content-with-automated-testing-and-open-source-tools

I do this myself sometimes, so noticed:
"screenreaders" should all be "screen readers"

The paragraph:
Every page should be tested using common screenreaders. If you’re using Apple devices you can use Voiceover for free, and if you’re using Windows then you can use NVDA for free.

Would be improved (I think), if it were:
Every page should be tested using common screen readers. If you’re using Apple devices VoiceOver is built-in. If you’re using Windows for testing we recommend installing the open source [NVDA](https://www.nvaccess.org/) screen reader for free. NVDA has become one of the [most popular screen readers](https://webaim.org/projects/screenreadersurvey8/) and although it is less powerful than JAWS, it is better for catching many accessibility errors.

There is still a preference for JAWS, as it is what governments are used to testing for. There are good reasons why testers should be focusing on NVDA though.

This is mostly in /app/views/best-practice/assistive-technology-testing/partials/screenreader-testing.md

Better broken links tests

The current acceptance tests for broken links look for 200 responses, but this causes some jump-links to pass when they should fail. We should write separate acceptance tests for jump links and make sure the page navigates to the correct headings.

Add link to guidance about riskiest assumptions in Alpha phase

In /best-practice/agile-teams#alpha, there's an opportunity to talk about risky assumptions related to access needs.

I'd suggest linking to the relevant page in the Service Manual, and also giving some examples of accessibility related assumptions, with some content about how to find and rank risky assumptions

Proposed content:

In Alpha, you should focus on testing your riskiest assumptions. You should take that approach with accessibility too. That means you don't need to test in Alpha with every single access need, just the ones that are most risky for your service. For example, one of your assumptions could be "Users who use screen readers will be able to access the content". If your service exclusively uses design patterns which are tried and tested, that particular access need may not be risky. But if your service uses more unique interactions, it may be more risky and so this assumption would need to be tested in Alpha.

Start by working out your accessibility assumptions, by working out which access needs would affect the use of your service the most. You could use the posters made by the Home Office as a starting point. Next, rank each one of these in terms of their risk level. Finally, test those assumptions and iterate your design until your confident that the risk level has gone down.

Accessibility Principles

Conversation around whether number 2 needs tweaked so that it is clear that accessibility is not always about people using tools. The last sentence should perhaps be re-written to say 'if' or 'whether' they use tools

2. Accessible design is good design

Good design should meet needs and solve problems. If you design something which is inaccessible you will create barriers for people. Good design is not just what looks good, it must be usable. It must work for everyone, regardless of what tools they use or what impairments they have.

Overlapping columns

This guide is great, I'm going to share it internally. One minor thing I noticed is that when the window is resized the columns on the homepage begin to overlap. Not sure if breaking over lines or switching to a single column sooner is the answer but thought I'd let you know!

Screenshot from 2020-12-09 09-44-53

(Firefox 83.0)

Why is this on a .com domain?

I love this initiative. I think the content is great and the guidance is useful.

But...

Why is this on a .com domain? Part of the success of modern digital government is about having a single, trusted domain. Here are my concerns:

  1. How long has this .com been registered for?
  2. What are the decommissioning plans?
  3. Has The National Archive been involved in preserving the content?
  4. How much is this costing to register and host?
  5. Is there any indication that this is a genuine service?
  6. What are the risks of a scammer registering accessibility-manual.com and trying to deceive your users?

As I say - this is brilliant work. I'm just concerned about the proliferation of domain names, and the unintended consequences that go with them.

Link to explain how to do keyboard only testing - most don't know how

On this page:
https://accessibility-manual.dwp.gov.uk/best-practice/manual-accessibility-testing

Provide more context here on how to do keyboard testing:
app/views/best-practice/manual-accessibility-testing/partials/keyboard-only.md

Webaim does a good job explaining how to do keyboard only testing. This one from NN/g is pretty good too https://www.nngroup.com/articles/keyboard-accessibility/

As part of your manual tests you need to make sure the page works as expected using [just a keyboard](https://webaim.org/techniques/keyboard/#testing). Every part of the page must be able to be viewed, and every interactive element must be usable.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.