arcade icon indicating copy to clipboard operation
arcade copied to clipboard

User study feedback: Tooltips or some kind of guidance for features in Build Analysis

Open missymessa opened this issue 2 years ago • 3 comments

Keeping in mind that we do have a character limit on the check, we should find some way to introduce some kind of help information on the check in the form of a low-tech tooltip (e.g. alt text over an image?) or something similar (not something that would add more noise to the check) if possible. Questions that these tooltips could clear up are:

  • What's the "Report Infrastructure Issue" (Known Issues) link for? When do I use reporting infra versus product?
  • What data is the test failure rate from AzDO based on?
  • (will add more :) )

missymessa avatar Sep 21 '22 21:09 missymessa

/cc @hoyosjs @MichalStrehovsky

missymessa avatar Sep 22 '22 17:09 missymessa

Is there some way to do this? I can't see any way to actually get any sort of tooltips to work. Also: alt-text for images is not ok from an accessibility point of view (even if we could figure out how to make that work). A screen reader treats the text as an alternative to the image and will read it aloud when encountered... so it should describe the image, and no more (it should be an alternative to the image itself). Using them as fake UI violates accessibility guidelines.

I do think we probably need a little help section/icon that links to some helpful page that can answer questions though.

It's unfortunate how limited we are in our UI options because of markdown.

ChadNedzlek avatar Sep 22 '22 23:09 ChadNedzlek

I do think we probably need a little help section/icon that links to some helpful page that can answer questions though.

Yep, this keeps coming up. Also, I like that we're focusing on making this intuitive.

markwilkie avatar Sep 23 '22 17:09 markwilkie

We'll include links to the Landing Page for better context around features.

missymessa avatar Sep 27 '22 17:09 missymessa

add link to landing page in https://github.com/dotnet/arcade/blob/main/Documentation/Projects/Build%20Analysis/LandingPage.md

AlitzelMendez avatar Jan 20 '23 23:01 AlitzelMendez

PR: https://github.com/dotnet/arcade/pull/12614

AlitzelMendez avatar Feb 16 '23 18:02 AlitzelMendez