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

Tag component: updated guidance #2733

Merged
merged 2 commits into from
Oct 3, 2023

Conversation

frankieroberto
Copy link
Contributor

@frankieroberto frankieroberto commented Apr 14, 2023

This updates the Tag component guidance to reflect design changes made:

Changes made:

  • removes the guidance about not mixing "solid colours" and "tints", as all the tags use lighter background colours now
  • added some content to the Research section about why the design changes were made
  • adds the new "light blue" tag colour to the example showing all the colour options

➡️ Preview of the changes

@netlify
Copy link

netlify bot commented Apr 14, 2023

You can preview this change here:

Built without sensitive environment variables

Name Link
🔨 Latest commit d02a406
🔍 Latest deploy log https://app.netlify.com/sites/govuk-design-system-preview/deploys/6515a0fc0563040008d14254
😎 Deploy Preview https://deploy-preview-2733--govuk-design-system-preview.netlify.app
📱 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 frankieroberto force-pushed the tag-changes branch 2 times, most recently from 51e6a34 to 9e420ba Compare May 23, 2023 18:50
@frankieroberto frankieroberto changed the title Tag design changes and updated guidance (WIP) Tag component: updated guidance May 23, 2023
@frankieroberto frankieroberto marked this pull request as ready for review May 23, 2023 18:57
@owenatgov owenatgov added this to the 5.0 milestone May 31, 2023
@owenatgov
Copy link
Contributor

Whilst we can't make these docs changes until 5.0 is merged, we can capitalise the content examples now in anticipation of the new design. @36degrees has thrown something together here #2809 which, when merged and this PR is rebased, should mean this PR is only handing guidance content changes.

@colinrotherham colinrotherham changed the base branch from main to support/5.x July 13, 2023 19:46
@colinrotherham
Copy link
Contributor

colinrotherham commented Jul 17, 2023

Hi @frankieroberto, would you mind rebasing this PR against release/5.0?

In preparation for pre-releasing govuk-frontend@5 we'd like to start previewing together all the GOV.UK Design System website changes that otherwise can't go into main yet whilst it's on govuk-frontend@4

Thanks

Update: Looks like I did this one already 🤦‍♂️

@stevenjmesser
Copy link
Contributor

Can this move to Ready to release, @colinrotherham? It looks like it's ready to go but doesn't have open questions on it, unlike some of the other Task List related issues and PRs.

@colinrotherham
Copy link
Contributor

@stevenjmesser Think it's still in review waiting for a content check?

Got the most minor of minor code tweaks then we can merge it into the v5 preview site

@stevenjmesser
Copy link
Contributor

OK, thanks for letting me know. Like other task list PRs, there's low capacity for doing anything on this until Design System Day is out of the way – although I suspect the co-design group could give it a review. Provided it's broadly in line with the way we write content on the design system website, it should be fine. Is there anything special we're looking for Design System content designers to do or add?

Copy link
Contributor

@stevenjmesser stevenjmesser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's worth adding any known research gaps (or where we need more evidence) to the 'Research on this component' section, so that other teams know the gaps and can add value by contributing evidence.

@frankieroberto
Copy link
Contributor Author

frankieroberto commented Sep 25, 2023

@stevenjmesser I don’t think we know of any known gaps (but there might be unknown gaps)?

What do you think of the content added to the Research section to explain why the design was changed based on research?

@colinrotherham colinrotherham force-pushed the release/5.0 branch 2 times, most recently from 530b8ef to 693bf28 Compare September 28, 2023 10:44
@stevenjmesser
Copy link
Contributor

@frankieroberto That content looks grand, thanks for adding it!

Copy link
Contributor

@stevenjmesser stevenjmesser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’ve checked this and there are no glaringly obvious problems. It’s well written content in the style of our guidance.

@colinrotherham colinrotherham self-requested a review October 3, 2023 07:37
Copy link
Contributor

@colinrotherham colinrotherham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, let's get it merged 🙌

(Confirming too that this is going into the v5 preview)

@colinrotherham colinrotherham merged commit 917e909 into alphagov:release/5.0 Oct 3, 2023
13 checks passed
@frankieroberto frankieroberto deleted the tag-changes branch October 3, 2023 09:55
colinrotherham added a commit that referenced this pull request Oct 9, 2023
colinrotherham added a commit that referenced this pull request Oct 11, 2023
colinrotherham added a commit that referenced this pull request Oct 13, 2023
colinrotherham added a commit that referenced this pull request Oct 17, 2023
colinrotherham added a commit that referenced this pull request Oct 23, 2023
colinrotherham added a commit that referenced this pull request Oct 25, 2023
colinrotherham added a commit that referenced this pull request Oct 26, 2023
colinrotherham added a commit that referenced this pull request Nov 1, 2023
colinrotherham added a commit that referenced this pull request Nov 3, 2023
@steve-oconnor
Copy link

@frankieroberto Finally, my 2 cents ...

Task list pages help users understand:

It’s a pattern, not a page and pages are listed separately. Might better to say “The task list pattern helps users understand:”

the tasks involved in completing a transaction

Should it say "transaction"? We talk about transactional vs non-transactional services, and a lot of people take the wording on these pages literally.

How about "the tasks involved in completing a process"

the order they should complete tasks in

“the order in which they should complete tasks”

when they’ve completed tasks

“when tasks have been completed”
“They” might not have completed the tasks, they might be checking someone else has.

Task list pages use a Task list component for each group of tasks on the page.

The task list pattern uses a Task list component for each group of tasks on the page.

Only use a task list page for longer transactions involving multiple tasks that users may need to complete over a number of sessions.

Only use a task list for longer transactions involving multiple tasks that users may need to complete over a number of sessions.

Try to simplify the transaction before you use a task list page. If you’re able to reduce the number of tasks or steps involved, you might not need one.

Try to simplify the transaction before you use a task list. If you’re able to reduce the number of tasks or steps involved, you might not need one.

You should show a task list page:

You should show a task list:

If you use a task list page in your service, you’ll need to:

If you use a task list pattern in your service, you’ll need to:

at the start of the transaction

at the start of a process

If you use a task list page in your service, you’ll need to:

If you use a task list in your service, you’ll need to:

group related actions into tasks

group related actions into a task.

If there are lots of tasks to complete, you might also need to group them further into steps.

If there are lots of tasks to complete, you might also need to group them further into sections or steps. The example at the top of the page has two sections.

Make it clear to users which tasks they’ve completed and which still need their attention, by labelling them using statuses.

Make it clear to users which tasks they’ve completed and which still need their attention, by labelling them using status tags.

  • I still think ‘Completed’ should use #505a5f rather than black :p

Make it clear to users which tasks they’ve completed and which still need their attention, by labelling them using statuses.

They are listed as ‘Tags’ in components and the word ‘tag’ isn’t used here at all.

Clearest option would be to spell it out:

Make it clear to users which tasks they’ve completed and which still need their attention, by labelling them using [tags](link to component) for each task’s status.

‘Not yet started’ uses a blue background, and ‘In progress’ uses a light blue background.

In the design phase we had agreed not to specify which text status and which colour should be used together.

I would loosen this up by saying:

Our research so far has favoured highlighting task that are yet to be started as the most prominent. So in the example we have ‘Not yet started’ using the blue tag, and ‘In progress’ using the light blue tag. User research for your particular service may suggest the opposite. Use what is most appropriate and please share your research.

Marking tasks as completed

Does the text of the radios improve by being less personalised by removing ‘you’? In some scenarios the person checking the info didn’t fill it out.

Maybe:

Is this section complete?

  • Yes, this section is complete
  • No, this section is incomplete for now

and then:

Select whether this section is complete or not

as the error message.

colinrotherham added a commit that referenced this pull request Nov 17, 2023
colinrotherham added a commit that referenced this pull request Nov 17, 2023
colinrotherham added a commit that referenced this pull request Nov 30, 2023
colinrotherham added a commit that referenced this pull request Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User requests new documentation or improvements to existing documentation tag
Projects
Development

Successfully merging this pull request may close these issues.

6 participants