search

department-of-veterans-affairs / va-mobile-app

"If VA were a company, it would have a flagship mobile app."
https://department-of-veterans-affairs.github.io/va-mobile-app/
17 stars 2 forks source link

Mobile app DS: Update content considerations for loading component #9207

Closed mistymg closed 1 month ago

mistymg commented 2 months ago

Description

While for some design system components, the Mobile App team directs to review the content considerations of VADS, VADS doesn't always provide helpful (or explicit enough) guidelines for how to develop content for a component. The loading indicator is one such case in which we could create more consistency by putting forth more consistent recommendations.

Acceptance Criteria

- [x] Content considerations written for loading component - [x] [Section of DS/doc site](https://department-of-veterans-affairs.github.io/va-mobile-app/design/Components/Alerts%20and%20progress/LoadingIndicator) updated ## Ticket Checklist - [X] Acceptance criteria defined - [X] Labels added (front-end, back-end, feature) - [x] Linked to an Epic
mistymg commented 1 month ago

While refining this ticket, I realized the rest of the documentation for this component could be improved regarding what the loading component is actually doing. Will work with DS team to make suggestions. As such, going to increase points to 3.

mistymg commented 1 month ago

Making following suggestion for component description: A loading indicator tells the user that the system is processing information, whether that is sending or receiving data. It provides reassurance to the user that the system is still working.

And drafted the following for content considerations:

We follow a simple content pattern for loading indicators: Present participle verb of action that is happening The object that is being acted upon An elipsis

Start each loading indicator with the present participle form (-ing) of the action that is happening. Consider what the system is actually doing. Remember that the loading indicator is supposed to inform the user what is happening while they’re waiting. The system isn’t always “loading” something. Sometimes its sending something. Other times its saving something. Follow the verb with the object that is being acted upon. For example, if the system is saving something, describe (in 1 or 2 words) what is being saved. If applicable, make the object personal to the user by using a possive pronoun (your) instead of an article (a, the). End each loading indicator with an ellipsis (3 periods) Do not use unnecessary words, such as please or wait. Examples of current loading indicators: Saving your draft... Loading your appointments… Submitting your file...

mistymg commented 1 month ago

Created this PR with changes to design system.