Open
Description
What
Decide whether to use the mixin 'descriptive title' (for example, "Common link mixin"), instead of the mixin code (for example, govuk-link-common), for primary headings in the Links section of our Sass API reference.
Why
This is an example of how mixin content currently displays, with the code first and the descriptive title second:
Would it be more meaningful to users if we displayed ‘Common link mixin’ first (and so on for the other mixins)? Are they likelier to think “I’m looking for govuk-link-common” or “I’m looking for a common link mixin”?
Who needs to know about this
Designers, Developers, Technical Writer, User Researcher
Done when we
- carry out any user research required
- decide whether to use the descriptive title as the primary heading
- implement agreed changes, if any