Style guide: Better markup for UI elements? #591
Replies: 1 comment
-
Closing this discussion as it didn’t get much traction. Let me know if you’d like to revive it after all. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
The MDN guidelines for talking about UI actions is (from here):
In task sequences, describe user interface actions using the imperative mood. Identify the user interface element by its label and type.
This guidance is good, but my experience is that UI elements are one of the cases where readers almost always benefit from using styling on the UI element name.
I've just been looking at a PR with this text:
I much prefer bold for the action as this makes it easier to see.
Markup should always be used sparingly, but this is a case where it can make things easier to parse. Even the simple case is better:
Anyone else think this is better/worth changing the guidelines for?
Beta Was this translation helpful? Give feedback.
All reactions