springernature / ux-elements-docs

UX Documentation for Elements design system
MIT License
1 stars 3 forks source link

Create component docs research task and discussion guide #50

Closed amyhupe closed 2 years ago

amyhupe commented 2 years ago

What

Create a task and discussion guide for upcoming usability testing of component documentation.

Why

We've recently changed our approach to writing component documentation to include both:

Our approach was based on research into what our users need from component docs.

We now want to test some of the new documentation to check our approach is working and meets needs.

Done when

Anything else

foxintherain commented 2 years ago

Started a draft on the discussion guide: https://docs.google.com/document/d/177bPZ9qkVpZn9o-RRfVUxePTWNfmV4NgZY52YO1q3XA/edit#heading=h.4dj5bjie8ggj

amyhupe commented 2 years ago

@foxintherain I've reviewed the draft and left some comments for you to take a look at.