search

department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
283 stars 205 forks source link

Error message audit #34491

Open DanielleThierryUSDSVA opened 2 years ago

DanielleThierryUSDSVA commented 2 years ago

Issue Description

As part of an iteration on the error message guide and dictionary, we need to compile error messages that are not currently in the existing error message dictionary.

Tasks

Acceptance Criteria

DanielleThierryUSDSVA commented 2 years ago

Hi @RLHecht. Here's the ticket for the error message audit. I think the easiest way to go about this might be to reach out to product teams and ask them to point you to where you can find the error messages they're currently using for their products. Or, potentially asked Kelson and team if they have an easier way to search all. I have, in the past when searching for error messages, searched within the vets-website repo, but not sure that's the best/easiest way. You can also search ZenHub for tickets that refer to error messages.

Note: This may take a while to gather all error messages. That's fine if it's a multi-sprint effort. Just noting that here. Thanks!

RLHecht commented 2 years ago

Update: Sent Slack to several teams for their error messages and continuing down the list. Moving to next sprint.

RLHecht commented 2 years ago

Authenticated Experience's error message matrix: https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/products/identity-personalization/my-va/error-messaging/error-message-matrix.md

RLHecht commented 2 years ago

Update: Public Websites created ticket #35506 to do a search of all error messages for us. They are grooming it for next sprint, so this ticket is blocked until then.

RLHecht commented 2 years ago

Update: PW completed their search and their findings are here: https://docs.google.com/spreadsheets/d/1wsDaib3HdivBbK5GRpN12OfuZBgaOlzqVUSURqLiT6g/edit#gid=0

We can move this out of blocked now and start up on the ticket again.

RLHecht commented 2 years ago

@GnatalieH As part of this audit we discovered that the error message dictionary in the style guide has an incorrect phone number that we need to update. We also want to replace (or remove for now) the screenshot that's at the top of the error message style guide since there's a typo and it's also a pretty old alert that doesn't meet our style standards anymore. Should I create a ticket for you to do this or can I make changes to this part of the style guide?

As a bigger conversation, Danielle and I want to set up a call with you to talk about this audit and what our next steps should be for revising the error message dictionary so that it has the error messages teams should be using for their products and getting rid of outdated ones. We also want to talk about the best way to present these error messages for usability. I can put something on all our calendars.

GnatalieH commented 2 years ago

@RLHecht here are my suggestions:

Remove the current image in the short term while I work on a newer one to replace it; I can create a ticket for that. Would you or someone else from Content be able to provide me with a screen shot of an example error message, or send the content you want to use? I can make a Sketch asset with annotations and then share it with you. Side note: do alerts still have buttons in them?

Yes, please feel free to set something up for us to meet, and please include @humancompanion-usds in the invite. Looking forward to it!