Error Documentation & Improvements

[kellylein]

Sprint 0: https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/products/va-mobile-app/features/Error%20Documentation/Error%20documentation%20sprint%200.md

Project Status Overview

Project Objective:

The VA: Health & Benefits mobile app team doesn’t have (1) an easily accessible and (2) detailed explanation of its error states.

Output of Epic:

Documentation that includes (but not limited to):

• Associated API error codes
• Explanation of error (and any special circumstances)
• Copy (headings, body copy, buttons, links, etc.)
• Component usage (potentially no need for a visual)
• Error documentation that is accessible to everyone (no Google)
• Owner/gatekeeper of this documentation

Current Dependencies / Blockers

Blockers

Blocker	Team / Owner	Est to Resolution

Project Timeline

Milestones

Step	Timing
Sprint 0 - Discovery
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
July '23
Aug '23	.....
Sep '23
Oct '23

Detailed Project Scope

Problem Statement

Assumptions

Risks

Definition of Done

Following needs to be true

Item	Completed

Project Scope

Items in and out of scope

In Scope	Out of Scope

Important Project Links

Links

• Github
• Product Brief
• Product Canvas
• Design
  • Discovery
  • Mockups
  • Final Design
  • Figma File
• Research
  • Document 1
  • Document 2
    -Analytics
  • Document 1

Team Members

Contact List

• OCTO Product Leads: Rachel Han and Ryan Thurlwell
• PM: Rachel Han
• Ad Hoc PM: Meko Hong
• Engineering: Jayson Perkins and Jon Bindbeutel
• Design: Lauren Russell
• External Team 1 & Role:
• External Team 1 & Role:

OKR and Analytic Metrics

Metrics

What we are measuring	Why	Event Name

Checklist

Toggle Product Checklist

Project Kickoff & Requirements Gathering

• Project Kickoff session
• Initiative Scope finalized
• Link Product Brief - Sprint 0
• 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
• 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

[mistymg]

Noted this in other ticket, but I think this discovery ticket on a related issue could be part of this epic. Ideally, we could document all errors and then use that documentation to look at where we could use caching to eliminate some errors and where we just need to rewrite others.

[mistymg]

Changed the name of this to Error Documentation vs. Error Content Documentation, and I'd suggest changing tag for this epic on the SoS board to reflect that change. It's more than just documenting the content.

[mistymg]

This epic also related to ticket 3815 in which Therese called out inaccurate our profile error messaging is. With the v2/user transition, Therese advised that a lot of these errors are not happening any more. But we should still include all profile-type errors in this broader epic.