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
281 stars 202 forks source link

Account Creation API: presenting options to affected tool stakeholders #94098

Open sterkenburgsara opened 1 week ago

sterkenburgsara commented 1 week ago

Description

Now that the code for the account creation API is available and our team has been able to look at it to assess our understanding of the API's architecture, we have validated how we will receive errors from the API (if they occur) and what alert messaging we generally need to create for users in those scenarios. However, this work is not only relevant on the MHV on VA.gov landing page - there are many side-door entry points directly to the affected tool applications themselves, so they tools will also need to serve these alerts on their end.

We suggest creating shared alert components that the other affected apps can grab & implement in their own applications, but we'll need OCTO to make a decision on a common user experience that we want to implement when/if these errors occur. In order to help them make this decision, Sara will diagram routing options and we'll need to:

This ticket is focused on the first bullet: presenting UX options to the affected tool POs

User story

As a Cartography team member, I want to clarify the needs of the account creation API to all relevant My HealtheVet on VA.gov stakeholders, and explain how the UX of alerts related to this API may affect users in their applications, so that they can collaboratively align on a common UX implementation strategy for this alerts in the scenarios where users enter the My HEaltheVet experience via direct side doors.

As a Veteran, I want to clearly understand why I am receiving an error or am not able to access certain tools within My HealtheVet so that I understand how to take steps to recover from those errors in a consistent way across the experience.

Notes

Possible tasks:

Acceptance criteria

wesrowe commented 1 week ago

UX refinement:

We're probably not ready for this. Still need discovery: is there a "pending" state in API/redux state?

Eng refinement:

We can probably make a recommendation based on what we know.

In full-team refinement we'll discuss how the ticket could be focused down to what we know today