Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example of summary list with missing information #1668

Merged

Conversation

frankieroberto
Copy link
Contributor

@frankieroberto frankieroberto commented May 13, 2021

This shows how you can use the summary list when there is some missing information. There’s a few scenarios when this can occur:

  • if a user returns to a partially-completed application
  • if additional questions have been added since the user first completed the task (for example, in a case working system)
  • optional questions
  • where the summary list is shown before the user starts answering the questions. Digital Marketplace adopted this pattern, in order to make it clearer up-front what all the questions were, and because multiple users might collaborate on a single application.

One option for tackling this is to leave the value column blank, or with some placeholder text such as "Not entered", whilst keeping a "Change" link in the actions column. However "Change" makes sense sense when there’s no existing value to change. The link could be renamed to "Add" or similar, but the wording is a bit awkward. Having a "Not entered" placeholder text can be harder to spot when scanning, or be mis-interpreted as words literally entered by a user. The placeholder text could be a different colour such as a dark grey, but this is quite subtle and relying upon colour should be avoided. A blank space is arguably easier to spot, but might be mis-interpreted as being an optional question.

To solve these issues, a more apparent way to make missing (and required) information apparent is to put a link in the value column, instead of a "Change" link. The link text could be a question, or the information required preceded by a verb such as "Enter" or "Select" (depending on context).

This pattern/component is being tested by different teams at the Department for Education. Feedback from other teams using similar patterns is welcome.

Screenshot

Screenshot 2021-05-13 at 16 04 49

Alternatives

It may make sense to add further highlighting using a blue border, either left of the key or the link text:

Screenshot 2021-05-13 at 16 07 59

Screenshot 2021-05-13 at 16 09 59

@govuk-design-system-ci
Copy link
Collaborator

govuk-design-system-ci commented May 13, 2021

You can preview this change here:

Built without sensitive environment variables

Name Link
🔨 Latest commit 2293f9f
🔍 Latest deploy log https://app.netlify.com/sites/govuk-design-system-preview/deploys/64e870555880070008831dfb
😎 Deploy Preview https://deploy-preview-1668--govuk-design-system-preview.netlify.app/components/summary-list
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@frankieroberto
Copy link
Contributor Author

frankieroberto commented May 17, 2021

More alternatives...

Using placeholder text for missing answers (eg 'None'):

Screenshot 2021-05-17 at 16 09 35

Making the placeholder text (eg 'Empty') dark grey:

Screenshot 2021-05-17 at 16 09 55

@rinto-c
Copy link

rinto-c commented May 20, 2021

This shows how you can use the summary list when there is some missing information. There’s a few scenarios when this can occur:

  • if a user returns to a partially-completed application
  • if additional questions have been added since the user first completed the task (for example, in a case working system)
  • where the summary list is shown before the user starts answering the questions. Digital Marketplace adopted this pattern, in order to make it clearer up-front what all the questions were, and because multiple users might collaborate on a single application.

One option for tackling this is to leave the value column blank, or with some placeholder text such as "Not entered", whilst keeping a "Change" link in the actions column. However "Change" makes sense sense when there’s no existing value to change. The link could be renamed to "Add" or similar, but the wording is a bit awkward. Having a "Not entered" placeholder text can be harder to spot when scanning, or be mis-interpreted as words literally entered by a user. The placeholder text could be a different colour such as a dark grey, but this is quite subtle and relying upon colour should be avoided. A blank space is arguably easier to spot, but might be mis-interpreted as being an optional question.

To solve these issues, a more apparent way to make missing (and required) information apparent is to put a link in the value column, instead of a "Change" link. The link text could be a question, or the information required preceded by a verb such as "Enter" or "Select" (depending on context).

This pattern/component is being tested by different teams at the Department for Education. Feedback from other teams using similar patterns is welcome.

Screenshot

Screenshot 2021-05-13 at 16 04 49

Alternatives

It may make sense to add further highlighting using a blue border, either left of the key or the link text:

Screenshot 2021-05-13 at 16 07 59 Screenshot 2021-05-13 at 16 09 59

Much prefer the link without left blue border. Until we know the plain links will get missed by users, it might be an unwanted distraction.

@frankieroberto
Copy link
Contributor Author

Here’s another pattern we're trying, using a blue border and some bold text with the full question, followed by the a link starting in a verb ("Select..." or "Enter...").

In this context, it’s someone editing some existing information where we have since added some extra questions, and so need to draw attention to these.

Screenshot 2021-05-21 at 11 22 49

@edwardhorsford
Copy link
Contributor

We’ve got a similar use case - needing to highlight answers that need to be changed / reviewed - but aren't missing.

We have data coming from another system, and it doesn't always match our data requirements. An example is us needing subjects to be selected from a long list of subjects - but the source data has a few occurrences of free text entry (which our system can’t support).

Where possible, we will automatically map / translate as much as we can. But in some cases we’ll need our users to fix the data. In this case we want to highlight these ‘invalid’ answers to our users to manually correct them. But also don’t want to imply that the person who originally entered the data did anything wrong.

The pattern we've come up with (influenced by some other work at DfE that @frankieroberto shared above):

  • Insert a notification banner at the top of the page that lists the fields that need changing
  • Insert a new styled section within the summary cards for each answer that needs correcting. These are very similar to standard error styling but with a different colour.
  • If the user tries to submit the page but doesn't correct the errors, replace the notification banner with an error summary, and style the inset areas red - thus we only style as errors once our users have made a mistake.
  • On the edit form page themselves, include a similar notification banner and inset styling.

Video:
invalid-answers

Initial page state

Notification banner

Screenshot 2021-05-21 at 11 35 56

Inset content within summary list

Screenshot 2021-05-21 at 11 36 04

Error state

Shown if a user checks I have reviewed the trainee data but has not corrected the issues.

Error summary

Screenshot 2021-05-21 at 11 36 17

Inset content

Screenshot 2021-05-21 at 11 36 22

Form page

Here we need to include the original data submitted in the message so our users know what to search for
Screenshot 2021-05-21 at 11 37 35

In an earlier version of this design, we pre-filled the fields with the original answers - but this really confused our participant as they could see nothing wrong with the text - better to have field be blank.


How it's tested

We've taken this through one round of testing with 9 users, and so far it's tested well.

For our first participant we were dynamically hiding the I have reviewed the trainee data checkbox, and did not have error styling. This tested terribly - the user did not see the banners or inset text, and the page didn't highlight anything was wrong - so they'd go to the page, and then click continue.

We later restored the checkbox so it would always be visible, and we give clear errors if you try to submit it - this has tested very well. Some users still had banner blindness initially, but for them the error styling and approach was clear and they were able to fix the issues.

Importantly, our users were clear that they were essentially being asked to 'massage' the data or make it fit - they understood this was a data quality issue and that the source of the data hadn't made a mistake.

@rinto-c
Copy link

rinto-c commented May 21, 2021

Here’s another pattern we're trying, using a blue border and some bold text with the full question, followed by the a link starting in a verb ("Select..." or "Enter...").

In this context, it’s someone editing some existing information where we have since added some extra questions, and so need to draw attention to these.

Screenshot 2021-05-21 at 11 22 49

I think this design makes sense in the context. How long (length) is your check your answer page in this context? Would it make sense to use blue colour for border and question when you have the link in same colour? The affordances might lose impact maybe?

@frankieroberto frankieroberto changed the title Add example of summary card with missing information Add example of summary list with missing information Mar 29, 2023
@frankieroberto
Copy link
Contributor Author

@christopherthomasdesign @owenatgov I'm going through old PRs and trying to tidy them up. Forgot about this one!

Is this change something you'd consider adding? Working out how to represent "missing" information in summary lists seems like quite a common issue that’s come up a few times.

@frankieroberto frankieroberto marked this pull request as ready for review June 30, 2023 08:25
This shows how you can use the summary list when there is some missing information.
@calvin-lau-sig7 calvin-lau-sig7 merged commit 3063c4d into alphagov:main Aug 25, 2023
12 checks passed
@frankieroberto frankieroberto deleted the summary-card-with-missing-data branch August 26, 2023 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

7 participants