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

'Share user research' guidance #2559

Merged
merged 3 commits into from
Oct 4, 2023
Merged

'Share user research' guidance #2559

merged 3 commits into from
Oct 4, 2023

Conversation

christopherthomasdesign
Copy link
Member

Draft of some guidance to help teams share useful research findings about things in the Design System

@netlify
Copy link

netlify bot commented Jan 27, 2023

You can preview this change here:

Name Link
🔨 Latest commit ae7328a
🔍 Latest deploy log https://app.netlify.com/sites/govuk-design-system-preview/deploys/651189e9caeaed0008876f9a
😎 Deploy Preview https://deploy-preview-2559--govuk-design-system-preview.netlify.app/community/share-research-findings
📱 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.

@colinrotherham
Copy link
Contributor

@christopherthomasdesign The PR to fix your Markdown code wrapping got merged by the way 👍

@calvin-lau-sig7 calvin-lau-sig7 force-pushed the research-guidance branch 3 times, most recently from b5b2f48 to 56b7da1 Compare September 6, 2023 09:34
@calvin-lau-sig7
Copy link
Contributor

Hi @christopherthomasdesign, @claireashworth

I've had a go at putting revised content from the doc into this branch, admittedly in semi-haste but feel like this is close to ready.

Would you care to review and see if there's anything else I might've missed for us to look at to get published? I've highlighted one section I've added that would appreciate a review.

Comment on lines +12 to +17
Useful findings to share might be things like:

- summaries of user research you’ve done
- prototypes or ideas that you’ve tested
- analytics from your service
- responses to any calls for information we give in the 'Research on this...' section of our pages
Copy link
Contributor

@calvin-lau-sig7 calvin-lau-sig7 Sep 6, 2023

Choose a reason for hiding this comment

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

Adding these examples is new — so appreciate any thoughts on whether this looks accurate.

@colinrotherham
Copy link
Contributor

Sorry @calvin-lau-sig7 due to the way Nunjucks renders before Markdown we need to use HTML for the link:

Before

{% set callout %}
Share information responsibly. [You must get informed consent from your participants](https://www.gov.uk/service-manual/user-research/getting-users-consent-for-research) before you can share findings of any research they’ve participated in.
{% endset %}

After

{% set callout %}
Share information responsibly. <a href="https://www.gov.uk/service-manual/user-research/getting-users-consent-for-research">You must get informed consent from your participants</a> before you can share findings of any research they’ve participated in.
{% endset %}

Otherwise it looks like Markdown is injecting <p> tags where it shouldn't

Typos

First line

Spacing

Add more examples of research

Apply suggestions from code review

Coding typo

Small code typo
@colinrotherham
Copy link
Contributor

@calvin-lau-sig7 There was one more <p> wrapping the govukWarningText() <div> so fixed it 👍

-<p>
 {{ govukWarningText({
   html: callout,
   iconFallbackText: "Warning"
 }) }}
-</p>

All passing now and deployment is working again

@calvin-lau-sig7 calvin-lau-sig7 marked this pull request as ready for review September 25, 2023 13:25
@stevenjmesser stevenjmesser merged commit 4b36278 into main Oct 4, 2023
12 checks passed
@stevenjmesser stevenjmesser deleted the research-guidance branch October 4, 2023 12:46
@CharlotteDowns CharlotteDowns changed the title Draft: 'share user research' guidance 'Share user research' guidance Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create guidance about sharing user research findings to the Design System
4 participants