-
Notifications
You must be signed in to change notification settings - Fork 231
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
Tag component: updated guidance #2733
Conversation
✅ You can preview this change here:Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
51e6a34
to
9e420ba
Compare
9e420ba
to
2441e3c
Compare
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. |
095f297
to
bc54352
Compare
Hi @frankieroberto, would you mind rebasing this PR against In preparation for pre-releasing Thanks Update: Looks like I did this one already 🤦♂️ |
01bf8df
to
e8224f2
Compare
2baa7bd
to
aca5326
Compare
bc54352
to
8735d03
Compare
358d0c3
to
8fdf688
Compare
8fdf688
to
a55f44a
Compare
8735d03
to
4562beb
Compare
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. |
@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 |
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? |
There was a problem hiding this 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.
@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? |
530b8ef
to
693bf28
Compare
Co-authored-by: Colin Rotherham <work@colinr.com>
e85550d
to
d02a406
Compare
@frankieroberto That content looks grand, thanks for adding it! |
There was a problem hiding this 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.
There was a problem hiding this 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)
Tag component: updated guidance
Tag component: updated guidance
Tag component: updated guidance
Tag component: updated guidance
Tag component: updated guidance
Tag component: updated guidance
Tag component: updated guidance
Tag component: updated guidance
Tag component: updated guidance
@frankieroberto Finally, my 2 cents ...
It’s a pattern, not a page and pages are listed separately. Might better to say “The task list pattern helps users understand:”
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 in which they should complete tasks”
“when tasks have been completed” “They” might not have completed the tasks, they might be checking someone else has.
The task list pattern uses a Task list component for each group of tasks on the page.
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. If you’re able to reduce the number of tasks or steps involved, you might not need one.
You should show a task list:
If you use a task list pattern in your service, you’ll need to:
at the start of a process
If you use a task list in your service, you’ll need to:
group related actions into a task.
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 status tags.
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.
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.
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?
and then: Select whether this section is complete or not as the error message. |
Tag component: updated guidance
Tag component: updated guidance
Tag component: updated guidance
Tag component: updated guidance
This updates the Tag component guidance to reflect design changes made:
Changes made:
➡️ Preview of the changes