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/
10 stars 1 forks source link

Make App Headings Consistent - Audit #4603

Open kellylein opened 1 year ago

kellylein commented 1 year ago

Project Status Overview

Project Objective:

Current Dependencies / Blockers

Blockers |Blocker | Team / Owner | Est to Resolution | |-------|---------|-------| | Work not prioritized for Mobile to work on | Mobile POs | TBD | | | | | | |

Project Timeline

Milestones |Step | Timing | |-------| ---------| |Sprint 0 - Discovery | Nov 2022 | |Step 1 - Strategy | | |Step 2 - Design | | |Step 3 - Building / Implementing | | | 100% Release | | |Step 4 - Post Verification| |

Monthly Update

Updates |Month| Project Health | Progress & Key Accomplishments| Issues/Risks/Blockers| |-------| ---------|--------|---------| |Sep '23| Not Started | Epic updated to new template; project included in Q4 planning | Work not prioritized | |Oct '23| Not Started | No update | Work not prioritized | |Nov'23| Not Started | Work was originally planned for Sprint 84 however it was pulled out of Sprint 84 due to capacity and resource issues. It will be revisited in future sprints for consideration. | Work not prioritized |

Detailed Project Scope

Problem Statement

Assumptions

List of Assumptions - Headings matter for screen reader users. There’s a lot of literature on this, including several WCAG success criterion and various web postings: - From [WCAG](https://www.w3.org/WAI/WCAG22/Understanding/headings-and-labels.html): Descriptive headings are especially helpful for users who have disabilities that make reading slow and for people with limited short-term memory. These people benefit when section titles make it possible to predict what each section contains. - From [an A11y Project post](https://www.a11yproject.com/posts/how-to-accessible-heading-structure/) (about websites, the principles apply to mobile): Headings are the backbone of the content of a page. A visitor should be able to scan the webpage using headings to get a good impression of its content. Heading levels have meaning, especially for screen reader users .... headings [represent] the page content similar to the index of a book: easily scannable and semantic. - Headings matter to the mobile team. A few relevant snippets from our current [accessibility standards](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/products/va-mobile-app/testing/Accessibility%20Test%20Plan.md): - We will “programmatically specify ARIA level for all text headings in React Native.” - “Screen reader should provide a breadcrumb like page read” - “Headings and labels design should describe topic or purpose and be programmatically determined as such.”

Risks

List of Risk - We spend time & energy bringing current screens to a good standard, but fail to future-proof and end up in a similar place for new features in a year - The modifications we make are up to our standards but don’t improve the experience for Veterans (screen reader users, etc).

Definition of Done

Following needs to be true |Item | Completed | |-------| ---------| | Full Audit of pages in the app and what headings are being used | have headings more ‘built-in’ to our design library and engineering components, so future us gets a really good basic approach to headings for free | | Come up with clear guidelines for heading structure: What should have a heading (which sections) and how headings should be written (what content/style for headings)| | Add automated checks for headings | | | Document in all the places (design library, documentation site)| |

Project Scope

Items in and out of scope |In Scope | Out of Scope| |-------| ---------| | | | | | |

Important Project Links

Links - [Github](url) - [Product Brief](url) - [Product Canvas](url) - Design - [Discovery](url) - [Mockups](url) - [Final Design](url) - [Figma File](url) - Research - [Document 1](url) - [Document 2 ](url) -Analytics - [Document 1](url)

Team Members

Contact List - **OCTO Product Leads:** Rachel Han and Ryan Thurlwell - **Ad Hoc PM:** - **Engineering:** - **Design:** Brea Blackwelder - **External Team 1 & Role:** Martha Wilkes - **External Team 1 & Role:**

OKR and Analytic Metrics

Metrics - Internal: - QA team attests that app headings meet our accessibility standards - % of screens with compliant headings (vs non-compliant headings) increases - External: - Qualitative: - Positive qualitative feedback in usability sessions and app store reviews - Quantitative: - % of eligible users can successfully complete a task with first attempt goes up on tasks where we implement the headings - Quicker completion of task on tasks where we implement the headings (all users, screen reader users) |What we are measuring | Why | Event Name |-------| ---------| ----- | | | | | | | | |

Questions

Open Questions
Closed Questions | Question | Answer | |--------|----------| | | | | | |

Change / Decision Log

Change & Decision Log Details | Change | Rationale | Decision Maker | Date Change | |-------|------- | -------- | -------- | | | | | | | | | | |

Checklist

Toggle Product Checklist **Project Kickoff & Requirements Gathering** - [ ] Project Kickoff session - [ ] Initiative Scope finalized - [ ] Link Product Brief - [Sprint 0 ](https://docs.google.com/document/d/1WHDJ1iCt9J-acLx8_DSL4tkRKoVYqJGaRUqXuFf7ceg/edit# ) - [ ] Link to Implementation Strategy - Implementation Plan - UAT Plan - Release Plan - Metrics Identified (what metrics are we capturing, how do they tie into stakeholder OKRs, etc) **Pre-Production Readiness** - [ ] Associate Readiness - [ ] Update product guide - [ ] Coordinate with contact center support teams - [ ] What’s New Content - [ ] App Store/In App messaging (if applicable) - [ ] Coordinate with Release coordinator - [ ] App store Content changes required? Y/N - [ ] App store images needed? Y/N - [ ] QA Signed off - [ ] UAT complete - [ ] Obtain Go/No Go decision **Feature Go Live** - [ ] Ensure Waygate/Feature toggle release ticket submitted w/engineering & QA - **Template: Turn on Waygate/Turn off feature flag** - [ ] Coordinate with content & release coordinator if what’s new in app is required
Toggle Team Collaboration Checklist - [ ] Design Intent & Feasibility discussions - [X] Research needed? No - [ ] UAT Needed? Yes/No - [ ] Ticket creation - [ ] Demo feature (mid check, end of development)
Toggle Design/UX Checklist - [ ] Review problem/opportunity statement - [ ] Add questions and assumptions to product brief - [ ] Add research links to product brief - [ ] Document high-level research/design plans - [ ] Create lo/hi fi wireframes & user flows if applicable - [ ] Add links to Epic & applicable GitHub folders - [ ] Socialize designs - [ ] Sign off received - [ ] Complete Design QA - [ ] Does it require component review? - [ ] Accessibility review needed?
Toggle Content Checklist - [ ] Review product brief and surface any questions, assumptions & risks - [ ] Participate in project discovery and kickoff activities/ceremonies - [ ] Complete comparative analysis/content research activities for net-new content - [ ] Review current content and determine where app may need to differ and potential improvements to share with web - [ ] Review past VA research and decisions documentation - [ ] Support Research & UX Design in research sessions and synthesis - [ ] Make content recommendations for lo-/hi-fi wireframes in collaboration with UX Design - [ ] Collaborate with Sitewide Content team for alignment, improvements, and sign-off - [ ] Participate in FE hand off - [ ] Complete content QA - [ ] Write copy for What's New In App - [ ] Write copy for app stores' What's New sections. - [ ] Write copy for updated screenshots in app stores
Toggle Engineering Checklist - [ ] Are UI designs/ specs available/ready? If yes, they should be attached to attach specs. (We are assuming the design specs have been approved) - [ ] Are there any deadlines that need to be met? - [ ] What is the roll out plan? (Do we need a feature toggle? is this going to be available to every user immediately or do we want to roll out to a few users first) - [ ] Does this project require api integration? if yes, what api endpoint are we integrating with and what is the expected response body? - [ ] Do we want to capture analytics for this projects (i.e. update GA, add logs to grafana/datadog etc)?If yes, what metrics would we like to capture?
Toggle QA Checklist - [ ] Create test plan - **Template: QA Test Plan** - [ ] Identify test data needs - [ ] Gotten & incorporated test plan review - [ ] QA Complete - [ ] Waygate tasks complete - [ ] Added new feature cases to the RC in TestRail - [ ] Added feature cases to appropriate section of active cases in TestRail - [ ] Spun up a (future) UI automation ticket for new feature
TKDickson commented 1 year ago

Hey @kellylein - a ticket predated the sprint 0 (#3860), do you want to turn that into an Epic instead of this new one? Or do you want to keep this new Epic, but attach that ticket? (Or some other thing I'm not thinking of)

kellylein commented 1 year ago

I have already attached the ticket to this Epic in ZenHub. ZenHub/GitHub doesn't allow converting a ticket from a normal Issue to an Epic ticket so this will have to do.

timwright12 commented 1 year ago

Is there anything we can do to help prioritize this bug? It's pretty widespread through the app.

kellylein commented 1 year ago

@timwright12 Since we converted this to an Epic due to the scope, let's be sure to bring this up in our next Quarterly planning so we can push to get it prioritized.

timwright12 commented 1 year ago

@kellylein Sounds great, thanks!

bischoffa commented 1 year ago

Per discussion during PM Sync involving Q2 planning on 3/22. Product proposes this should be done in Q2 - so quarter has been updated.

bischoffa commented 7 months ago

Planned for Sprint 84 but pushed out because of PM capacity and other priorities.

brea11y commented 5 months ago

The app headings audit has been completed and the full list of results can be found in this Google sheet. I have also created ticket #7677 for Misty with a list of app headings that need content's review.