Skip to content

Commit

Permalink
Update the wording
Browse files Browse the repository at this point in the history
Signed-off-by: Olga Bulat <obulat@gmail.com>
  • Loading branch information
obulat committed May 24, 2024
1 parent 48ffbaf commit 7b7df91
Showing 1 changed file with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -133,13 +133,15 @@ were discarded as they would be less user-friendly.
screen readers treat the tooltips differently.
2. Display one section per each machine-generated tag provider, and label
sections with relevant heading, e.g. "Machine-Generated Tags: Rekognition".
In each section, list the tags in the order of their accuracy. Each tag would
display the tag name and the tag accuracy. This way, the user will see the
data without additional actions such as hovering. We have enough room on the
page to display this data in full. As a bonus, if a tag is generated by
multiple providers, the user will see that different providers generate the
same tag, and will be able to see the difference in accuracy between the
providers.
Each provider section would sort the tags in the order of their accuracy, and
each tag would display the tag name and the tag accuracy. This way, the user
would see the data without additional actions such as hovering. We have
enough room on the page to display this data in full. As a bonus, if a tag is
generated by multiple providers, the users would be able to see that
different providers generate the same tag, and the difference in accuracy
between the providers. This option wasn't selected because we don't yet have
enough user data to know if the users would find this information useful
instead of overwhelming.

## Design

Expand Down Expand Up @@ -174,12 +176,10 @@ who do not have a hover action. MDN's section on tooltip best practices suggests
providing "clear labels and sufficient body text" instead of tooltips that hide
important information.

The third alternative option, where the provider is displayed once per the list
of all the generated tags generated by it, and accuracy is displayed on the tag
itself, is the most accessible option. The user will see (or hear) the provider
and the accuracy of the tag without any additional actions. We need to make sure
that the tag name and its accuracy are separated (such as with an invisible,
`sr-only`, dot) to make the screen readers add a pause between them.
If we decide to display the accuracy on the tag together with its name (option 2
above), it is important to separate the tag name and its accuracy (with an
invisible, `sr-only`, dot, for instance) to make the screen readers add a pause
between them.

## Rollback

Expand Down

0 comments on commit 7b7df91

Please sign in to comment.