Allow explanations for failures in lists of instances

[hollsk]

Is your feature request related to a problem? Please describe.

Some of the categories produce a list of elements on the page that you can mark as a pass or fail. Sometimes it's not immediately obvious to another person why you've marked a particular instance as a fail.

e.g. I might want to fail <h1><img src="logo.gif" alt="Project Name"></h1> under "Headings -> Heading function" because the alt text doesn't describe the purpose of the page and shouldn't be a heading.

I might also want to fail <img src="logo.gif" alt="header logo"> under "Images -> Text alternative" because the alt text doesn't have parity with the text in the logo.

Currently there's no way for me to actually say that in the report - I just have to mark it as a fail and hope the person reviewing the report (who might be the same person who implemented the original code!) understands the problem.

Describe the desired outcome

It'd be good to be able to add a comment in lists of instances (e.g. headings, images) to make it clear in the exported report why an item has been flagged.

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

This is a fantastic tool, thanks so much for your hard work on it! 😄

[msft-github-bot]

This issue has been marked as ready for team triage; we will triage it in our weekly review and update the issue. Thank you for contributing to Accessibility Insights!

[msft-github-bot]

This issue requires additional investigation by the Accessibility Insights team. When the issue is ready to be triaged again, we will update the issue with the investigation result and add "status: ready for triage". Thank you for contributing to Accessibility Insights!

[ferBonnin]

Thanks for the feature request @hollsk! We will add the tag "needs help" and if someone in the community wants to help make this happen we can provide the mock-ups for this.

Some additional thoughts on this, we already have a panel to add a comment for manual instances, so that can be re-utilized for this. Each element row will need to have a way to add a comment as well as an indicator that there is a comment. The report will need to add a comment for the failure instances that have a comment. Also need to consider that if an instance is marked as pass then the user cannot add a comment (currently passed instances are not listed in the report)

[joppekroon]

After doing my first assessment this was my main problem with the tool.

From a user perspective it is weird that some checks have the option for comments, and others do not. This requires you to have an accompanying document to record your comments anyway, reducing the usefulness of the report and the comments that you can add.

Additionally, there were cases where I wanted to explain why I passed a certain check, so I don't agree at this point with the idea that you shouldn't be able to add a comment when the item/check is marked passed.

[ferBonnin]

Thanks for your feedback @joppekroon! After taking a look, we do send the details of a pass instance into the report, so a comment for passed or failed instance could be in the report.

We have marked this issue as "needs help" in case someone in the community wants to take a look :)

[ebarrette-lhob]

+1 for this feature request. Excellent tool can be made better with comments feature added to all manual tests pass or fail.

[ssawczyn]

Absolutely love this suggestion, would be extremely handy to optionally be able to add comments in order to provide additional context around why something is marked as a failure, or possible remediation guidance to promote consistency.

[katannshaw]

+1 to this request. It's the one issue I have with this tool. If I could add notes to each pass/fail instance, it would be almost perfect.

[anipv]

+1 to this request. Looks like there has been a request for this feature since 2019. We are now into October 2023. Please consider adding this feature. If I could add notes to each pass/fail instance, it would be almost perfect.
Ability to add comments, if needed, in lists of instances when an item is flagged as a failure. #7017