alphagov / govuk-design-system

One place for service teams to find styles, components and patterns for designing government services.
https://www.gov.uk/design-system
MIT License
497 stars 231 forks source link

Unexplained abbreviations on website #4010

Open selfthinker opened 1 month ago

selfthinker commented 1 month ago

This issue is from the accessibility audit of the Design System website by DAC in July 2024.

DAC's description

The abbreviation 'GDS' was present throughout the page which was not conveyed in its expanded form when it was first used. This could be problematic for some users who may not be familiar with the meaning of the acronym.

Screenshot of the use of the acronym GDS on the homepage

Current code

<p class="govuk-body">
   See what the Design System team at GDS is planning to work on over the next 12 months in the <a href="/community/roadmap/" class="govuk-link" data-hcontribute="guidelinegh">GOV.UK Design System Roadmap</a>.
</p>

Cognitive user comments

“At the bottom of the page the acronym ‘GDS’ is used without an explanation on the page. I would not expect a user to understand any acronym immediately as different services and industries may use the same acronym to mean different things. This can lead to confusion, or mistakes being made if a user assumes the acronym may stand for something else. Those with short term memory loss will also have trouble remembering acronyms.”

DAC's proposed solution

Ensure that all acronyms and abbreviations are expanded upon in the first instance to ensure that all users can understand what they represent. Using the expanded state of the of the abbreviation will ensure that users can clearly determine what they are accessing; this is particularly important for users who may experience cognitive difficulties. For more information, please refer to Technique G102: Providing the expansion or explanation of an abbreviation.

Thoughts about the solution

While it's generally a good idea to expand abbreviations and acronyms, in this particular case ("GDS") it might be fair to argue the need for fixing it depends on how well our target audience knows it. I'd propose to only fix those acronyms that we think would otherwise be confusing for our target audience.

Additional instances

DAC's report mentions additional instances in the Accessibility strategy.

As this can potentially happen on any page, this work should include checking all the other pages for other uses of abbreviations. It might be worth making two different cards for this: One for checking and recording all instances, the other for fixing them.

To save time, it makes sense to audit all the body copy issues together:

Needed roles

Content designer

calvin-lau-sig7 commented 3 days ago

To detect, we can:

To assess, we'll need to:

To resolve, we can:

selfthinker commented 1 day ago

Just for more context, this is what the GOV.UK Style Guide says about abbreviations and acronyms. As a lot of our content is technical, it's also worth checking the style guide for technical content as that mentions a couple of acronyms that should not be expanded.