department-of-veterans-affairs / vets-design-system-documentation

Repository for design.va.gov website
https://design.va.gov
38 stars 57 forks source link

Adding research insights to component pages #430

Open CrystabelReiter opened 3 years ago

CrystabelReiter commented 3 years ago

VFS teams want to be able to add research findings per component to our design system. e.g. if we start seeing patterns in our research about specific components. We want to create an easy way for VFS designers/researchers to update a "research insights" section on each component.

DST suggestion for creating a process around adding research insights to component pages. (Found these examples in gov.uk design system and Australian gov design system)

We make a GH issue for each component in the design system repo and label them "component." When a VFS designer wants to add a research insight or suggestion update for an existing component, they can comment on the ticket. This way we can track all research insights/suggestions on one ticket. The DST designer can add these insights on the design.va.gov component page under a section called "Research insights." We will link the component issue to the component page on design.va.gov so designers can easily find it.

Examples from gov.uk design system:

Screen Shot 2021-04-16 at 10 51 20 AM

https://github.com/alphagov/govuk-design-system-backlog/issues/44

https://community.digital.gov.au/t/inpage-nav/82

CrystabelReiter commented 3 years ago

Action item: Make a product outline around this feature

humancompanion-usds commented 2 years ago

We now link to our Research repo from every component. There are not always research sessions, and thus not always issues in that repo, for each component. That was a good first step towards this goal. However, I do agree that the pattern here of extracting important research onto the component documentation page itself is a good one. Thus we'll get to this in future and prioritize VA-specific components (i.e. components that were created by VA and that do NOT overlap with USWDS components).