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

Explore adding a button to Exit this Page component guidance for teams to inform us when they have used it #2849

Closed kellylee-gds closed 1 year ago

kellylee-gds commented 1 year ago

What

Add a button to the guidance where teams are encouraged to share their service name, department and consent to contact for further research.

Mvp button could be 'We have used this component".

Also consider whether the button is needed on both the component guidance and pattern, or just the component guidance.

Why

To help us track where EtP is being used and set up further conversations.

Who needs to work on this

TBC - need further info from the team before decision reached.

Who needs to review this

TBC

Done when

stevenjmesser commented 1 year ago

There's a couple of options for how this could work. What feels simplest and closer to a complete solution (to me) is to hand the user off to a styled SmartSurvey, which handles data storage and privacy notices, reducing the amount of work to do with Information Assurance. It also allows us to include a question asking which components and patterns are used on a service, meaning we collect more information through one form; if a form was embedded on each component or pattern page instead, that's a lot of forms to fill in!

We might also want to collect service name, organisation name and a contact email address to help with de-duplicating submissions too. Collecting the email address allows us to screen out spam submissions too. (We can suggest that mailbox is used instead of a person's email address, though both are fine.)

I've had other thoughts of how this would feed into better collecting data on usage of the design system, so would love to chat that through with anyone involved in this. It shouldn't widen the scope but will make sure all the work aligns and the data can be analysed.

calvin-lau-sig7 commented 1 year ago

Summary of what I reckon how the links for #2848 and #2849 will look on the component and pattern pages:

On the ‘Help improve this component/pattern section’, replace the link to the backlog issue page (example) to a new GitHub discussion category (example) page.

In the same section, also add a button to a survey or form tool

stevenjmesser commented 1 year ago

Personally I’m agnostic as to whether it needs to be a button, happy to go with whatever a designer recommends.

owenatgov commented 1 year ago

Weighing in:

I think a SmartSurvey link is fine. Is there anything we need to think about re: branding or is this already handled? I remember Vanita doing some work years ago on branding SmartSurvey using govuk-frontend.

The changes to 'Help improve xyx' will require some dev work as this partial is currently quite rigid. I don't anticipate this being a challenge, we just need to think about how to extend it so that it doesn't break other components and how they pass data to it. We have the option to update how all our pages use that partial fairly easily though so whilst there's a light unknown, it's not a major concern.

owenatgov commented 1 year ago

We could mitigate dev work by putting the button/link/whatever in the content itself ie: between the H1 and that Help improve partial. I don't think it's worth passing on a decent design just because it reduces the effort though as I think the effort is going to be fairly low anyway.

stevenjmesser commented 1 year ago

Sounds great, thanks for your thoughts, @owenatgov.

SmartSurvey is all branded up, yes (or it was when I checked earlier in the year, can't imagine it will have changed).

stevenjmesser commented 1 year ago

Here's a couple of sketches/scrappy prototypes based on @owenatgov's hardcoded approach. The content is bad, would definitely need @calvin-lau-sig7's help with that!

image

image

The link opens a SmartSurvey, e.g. https://surveys.publishing.service.gov.uk/s/preview/JQ7GLT/699DFE6BB168F2E0B7E9A5440B8B50

stevenjmesser commented 1 year ago

Slight iteration: added a sub-heading and 'opens in new tab' text.

image

kellylee-gds commented 1 year ago

Looks great!

stevenjmesser commented 1 year ago

Here's a survey I threw together https://surveys.publishing.service.gov.uk/s/preview/MPR0MV/9901FD8DF46ED73D593D58630D2660

stevenjmesser commented 1 year ago

Published survey here: https://surveys.publishing.service.gov.uk/s/MPR0MV/

stevenjmesser commented 1 year ago

@calvin-lau-sig7 added a commit for this to the guidance PR: https://github.com/alphagov/govuk-design-system/pull/2721/commits/f189d5d7b69b8fd6755062e3b771c34d7f2da494