diff --git a/apps/docs/src/common/pages/content-style-guide/designing-for-limited-english.tsx b/apps/docs/src/common/pages/content-style-guide/designing-for-limited-english.tsx index 1e886475..4ae54327 100644 --- a/apps/docs/src/common/pages/content-style-guide/designing-for-limited-english.tsx +++ b/apps/docs/src/common/pages/content-style-guide/designing-for-limited-english.tsx @@ -34,8 +34,8 @@ const Page: FC = ({ location }) => (
  • use clear language
  • check how it translates
  • test language with users
    • -
  • avoid idioms, like ‘wear and tear’
    • -
  • avoid phrasal verbs, like ‘look up’ or ‘carry out’
    • +
  • avoid idioms, like 'wear and tear'
    • +
  • avoid phrasal verbs, like 'look up' or 'carry out'
  • use simple tenses
  • write acronyms in full
  • avoid all contractions
    • @@ -68,12 +68,12 @@ const Page: FC = ({ location }) => (
  • dependant
    • -

    Content designers working on visa application forms have been using ‘money’ instead of ‘maintenance’ or ‘financial support’ because it translates better in some of the languages used by their users.

    +

    Content designers working on visa application forms have been using 'money' instead of 'maintenance' or 'financial support' because it translates better in some of the languages used by their users.

    Use online translators for guidance purposes only. These are external websites which can change at any time. While they are improving, they are far from perfect. Do not put sensitive information into online translators because that information can be stored and you have no control over how it is used.

    Test language with users

    -

    Guidance cannot replace the insight gained from testing your content with low-fluency English speakers. Content designers creating an asylum application form found that ‘medicine’ tested better than ‘medication’. The NHS style guide also advises using medicine.

    +

    Guidance cannot replace the insight gained from testing your content with low-fluency English speakers. Content designers creating an asylum application form found that 'medicine' tested better than 'medication'. The NHS style guide also advises using medicine.

    Test all important content in your service, including, but not limited to:

    -

    Recruit participants with limited fluency and choose the most appropriate method for testing your content. For example, if some users need an interpreter to use your service, consider testing the service with an interpreter alongside a user.

    +

    Recruit participants with limited English and choose the most appropriate method for testing your content. For example, if some users need an interpreter to use your service, consider testing the service with an interpreter alongside a user.

    Avoid idioms

    @@ -95,10 +95,6 @@ const Page: FC = ({ location }) => (

    Avoid phrasal verbs

    A phrasal verb is where you combine a verb with other words to make it mean something different, such as ‘carry out’, ‘get over’ or ‘look after’. English is full of them. But their meaning is not always clear until you have learned them.

    There is nearly always a one-word alternative to a phrasal verb that is easier to translate.

    - -
    -
    - @@ -169,14 +165,11 @@ const Page: FC = ({ location }) => (
    -
    -
    -

    Use clear language whenever possible but if the alternative word translates better, consider using that instead.

    Use simple tenses

    The present and past tenses are the easiest to understand. Avoid sentences with complex tenses like ‘it will have worked’.

    -

    You will often have to use the future tense. But you can sometimes avoid it by writing in the active voice. For example, ‘how your information will be used’ may be easier to understand written in the present tense: 'how we use your information'.

    +

    You will often have to use the future tense. But you can sometimes avoid it by writing in the active voice. For example, 'how your information will be used' may be easier to understand written in the present tense: 'how we use your information'.

    To make your content more direct, use the present tense instead of 'should have' or 'would have'.

    For example, instead of:

      @@ -187,11 +180,11 @@ const Page: FC = ({ location }) => (

      Write acronyms in full

      Research has found that some users struggle to remember the meaning of an acronym they saw on a previous screen. Write an acronym in full the first time you use it on a new page or screen, unless it is well known to 80% of your users, like UK, US or NHS. For example, write 'biometric residence permit (BRP)' on each screen of your service at first mention and use 'BRP' if it appears again on the same screen.

      Translation tools do not translate acronyms. For example, 'National Health Service (NHS)' translates to 'Serviço Nacional de Saúde (NHS)' in Portuguese. Users may not recognise 'NHS' on a later screen.

      -

      If available, use a tooltip, like acronym Markdown, to make the acronym appear in full as hover text.

      -

      See more guidance on abbreviations and acronyms in the GOV.UK style guide.

      +

      If available, use a tooltip, like acronym Markdown, so that when a user hovers over the acronym they see it written in full as 'alt text'.

      +

      See more guidance on abbreviations and acronyms in the GOV.UK style guide.

      Avoid all contractions

      -

      Avoid all contractions, including positive contractions like 'we'll', 'you've' or 'they're', if your users have limited English. Research suggests that contractions make content difficult to understand for people with limited fluency. See general guidance on contractions in the GOV.UK style guide.

      +

      Avoid all contractions, including positive contractions like 'we'll', 'you've' or 'they're', if your users have limited English. Research suggests that contractions make content difficult to understand for people with limited English. See general guidance on contractions in the GOV.UK style guide.

      @@ -200,7 +193,9 @@ const Page: FC = ({ location }) => ( Sign showing camera and fingerprint icons to explain in different languages how biometric information is taken.

      -

      Make sure you include text alternatives for users with visual access needs.

      +

      Make sure you include text alternatives with images for users with visual access needs.

      + +

      Research with vulnerable users on the eVisa service found that most participants, including fluent English speakers, found the written guidance too long and technical. They said the information in the What is an eVisa video was easier to understand.

      @@ -217,7 +212,7 @@ const Page: FC = ({ location }) => (
    • what happens when funding for translation ends
    -

    Work with your team and stakeholders to understand the benefits and costs of hiring translation services. This isn’t just about business pressures. There may be risks if a service is only partially translated or something has been mistranslated.

    +

    Work with your team and stakeholders to understand the benefits and costs of hiring translation services. This is not just about business pressures. There may be risks if a service is only partially translated or something has been mistranslated.

    Help improve this guidance

    To contribute, join the GitHub discussion.