nhsuk / nhsuk-service-manual

Design and build digital services for the NHS. Use the service manual to build consistent, usable services that put people first.​ Learn from the research and experience of other NHS teams.
https://service-manual.nhs.uk
MIT License
64 stars 25 forks source link

Review accessibility guidance on page titles #1018

Open ghost opened 3 years ago

ghost commented 3 years ago

What

As part of the review of our accessibility pages, the guidance for content on setting page titles (linked here) needs to be reviewed.

Also, we may want to review where this guidance sits.

Current guidance

Screenshot 2024-05-07 at 11 19 02

Why

The guidance needs to clarify how page titles differ from page names.

We see that quite a lot of people can't find this guidance.

Done when

sarawilcox commented 3 years ago

Hi @AJSMITH1512, here's the current guidance: https://service-manual.nhs.uk/accessibility/content#set-page-titles

Is the following text clearer? I'll run it by a few content designers this week, and will check it with the team and Ben too before asking the AWG to approve the change.

Set page names and page titles For: Content, Development, Testing

The page name:

The page title:

If you can, use templates to keep things consistent and use your content management system (CMS) to add the site name after the dash.

Good page names:

@davidhunter08 or @AdamChrimes, for info. This content didn't work well for content designers so I'm going to rethink and chat with Adam and Dom on Friday.

sarawilcox commented 3 years ago

Should probably go to AWG too. I'm testing it with some content designers this morning. @EllenDoyle @georginaplatt, see my Slack message.

sarawilcox commented 3 years ago

Notes from crit with content designers

sarawilcox commented 3 years ago

See Slack thread: https://nhsuk.slack.com/archives/C6S0QTW9X/p1624370799028200?thread_ts=1624368546.027100&cid=C6S0QTW9X

sarawilcox commented 3 years ago

We say this in the accessibility guidance: https://service-manual.nhs.uk/accessibility/content#set-page-titles, i.e. Page title - Site name. For example: Achalasia - NHS. I think we're OK on the health content front, because it's templated in Wagtail. But we're not consistent with services. We have some services that follow the GOV.UK pattern: eg: Do you know your NHS number? - Book a coronavirus vaccination - NHS. https://www.nhs.uk/book-a-coronavirus-vaccination/do-you-have-an-nhs-number. And some which don't mention that it's the NHS website, e.g.: Search - Find a walk-in coronavirus (COVID-19) vaccination site. https://www.nhs.uk/service-search/find-a-walk-in-coronavirus-covid-19-vaccination-site

sarawilcox commented 3 years ago

Had a chat with Alistair Duggin and Sarah Norman about this. We know that some transactional services are failing WCAG2.1 AA on page titles. Other pages are not following latest best practice.

Alistair is going to draft a brief note with examples and best practice that could go in the accessibility guidance.

We also need a way to make this guidance easier to find in the service manual. It's not just an accessibility issue.

sarawilcox commented 2 years ago

This all needs further review and testing. Put back into team backlog for now.

sarawilcox commented 5 months ago

See also our draft URL guidance: https://github.com/nhsuk/nhsuk-service-manual-community-backlog/issues/265

The BBC guidance for title is Page name - Section name - BBC

And the GOV.UK guidance is: Page name - Service name - GOV.UK eg https://www.registertovote.service.gov.uk/

Screenshot 2024-05-09 at 10 24 09

Writing for user interfaces says: "Each page should have a single<h1>. The <h1>should describe what the page does. The <title> should be based on the <h1>, and follow this format: Where do you live? - register to vote - GOV.UK"

sarawilcox commented 5 months ago

Page titles should be short. GOV says "Your title should be 65 characters or less (including spaces). You can use more than 65 characters if it’s essential for making the title clear or unique, but do not do this routinely because:

A lot of our page titles are very lengthy.

sarawilcox commented 5 months ago

Page title - HMRC guidance

sarawilcox commented 5 months ago

I think we've seen teams struggling with titles, H1s and URLs for fail pages.

For example, a service may have quite a lot of pages with the heading "You cannot use this service". The body copy explains why.

The URL will be different in each case and may reflect why this applicant is not eligible. E.g. .../apply/under-16

See GOV Custom error and fail pages GitHub issue.

edwardhorsford commented 5 months ago

I'm a new user of the NHS Design system so recently queried the policy on titles.

There's some guidance under the accessibility section, but alas I didn't find it.

Some extra things it would be good to cover:

I think the app itself might use NHS App, but we may decide that services within it don't - many things are available both within the app and via the web. If we ask them to add NHS App to the end of their titles I think it implies the page title being dynamic based on use case - which might be challenging for some services.

sarawilcox commented 5 months ago

What about hyphens, en-dashes etc in title? Does it make a difference?

GOV uses hyphen: Where do you live? - Register to vote - GOV.UK (https://www.gov.uk/service-manual/design/writing-for-user-interfaces#headings-and-title)

sarawilcox commented 5 months ago

Interestingly the NHS.UK CMS uses a hyphen by default, but it would not be v difficult to change this to an en-dash.