mi6
Restructure Component > Guidance and Component > Code
What component is this related to?
Research outcomes
Description
Ensure Component > Guidance contains all information a UX designer would need to use a component, and Component > Code contains all information a developer would need to use a component.
Guidance on the Code tab could be written as a quick sentence under the relevant variant (or variant section if it applies to all variants).
For example, Select guidance such as "when more than 10 options are available, use the searchable variant" is relevant to developers as well as designers, so it should also be in the Searchable section of the Select code tab.
Additionally, in the Button guidance, there is a lot of guidance on how to write an accessible label, some of which is useful for developers. This guidance should also be in the Code tab.
Why do we need it?
Ensures that the structure of the site matches observed user behaviour, to ensure users from all professions are accessing the information they need.
🚨 Urgency (low, medium or high)
Priority 4/5
Related open issues
[Link to other GitHub issues]
Scope of this ticket:
- Take Data Table as the exemplar of level of documentation we want.
- Review all component pages, identify areas on Code pages that need more guidance written to bring them up to standard
- Create ticket for the writing of the rest of the guidance (create with a Task list, one checkbox per component, allowing multiple devs to work on at once) - listing each Component Page as No Guidance Yet / Partial Guidance / Full Guidance Already
