Content style guide

System messages

Alerts the user of important system-related issues or status. It’s initiated by the system and it’s not a result of the user’s actions.

Note: See the help users to recover from errors pattern for guidance on when to consider adding instruction to call the VA.gov help desk or other “next-step” call to action.

Scheduled downtime notifications

Scenario Message title Message content Component State

Site-wide

Advance notification Upcoming site maintenance We’ll be doing some work on VA.gov. The maintenance will last x hour. During that time, you won’t be able to sign in or use tools.
Date: Day, Date, Year
Start/End time: 0:00 a.m. to 0:00 a.m. ET Maintenance banner Before maintenance

Advance notification/24 hour Upcoming site maintenance We’ll be doing some work on VA.gov. The maintenance will last 24 hours. During that time, you won’t be able to sign in or use tools.
Start: Day, Date, Year, at 0:00 a.m. ET
End: Day, Date, Year, at 0:00 a.m. ET Maintenance banner Before maintenance

During downtime Site maintenance We’re working on VA.gov right now. If you have trouble signing in or using tools, check back after we're finished. Thank you for your patience.
Date: Day, Date, Year
Start/End time: 0:00 a.m. to 00:00 a.m. ET Maintenance banner During maintenance

During downtime/24 hour Site maintenance We’re working on VA.gov right now. If you have trouble signing in or using tools, check back after we're finished. Thank you for your patience.
Start: Day, Date, Year at 0:00 a.m. ET
End: Day, Date, Year at 0:00 a.m. ET Maintenance banner During maintenance

Entire site is accessible We're working on the site We’re working on VA.gov right now. You should still be able to use the applications and tools. But if you have any trouble, please check back soon. Maintenance Banner Warning

In-app

During downtime We're working on [APP name] right now If you have trouble using this tool, please check back after [Month, Date] at [00:00 a.m./p.m. ET]. Modal Warning

Partial downtime notification Some online tools or services aren't working right now You may have trouble accessing some features on VA.gov at this time. We’re working to fix this. Please check back soon. Alert Warning

Sign-in page

During downtime You may have trouble signing in with [DS Logon, MyHealtheVet, ID.me] We’re sorry. We’re working to fix some problems with our [DS Logon, MyHealtheVet,ID.me] sign in process. If you’d like to sign in to VA.gov with this account, please check back later. Alert Warning

Unscheduled downtime notifications

Scenario Message title Message content Component State

Site-wide

In-app

During downtime This application is down for maintenance We’re making some updates to this tool. We’re sorry it’s not working right now. Please check back soon. Modal Informational

Sign-in page

Updates to user data (system-initiated)

Some messages written to reflect the example; other variations will be added to expanded dictionary section.

Scenario Message title Message content Actions Component State Location

Status update (e.g. claim closed) Your [CLAIM TYPE] claim update Our records show that your claim was closed on [DATE]. N/A Alert Informational Replace affected component

Action required (e.g. claim evidence request) We need your help to finish reviewing your claim Please provide more evidence (supporting documents) so we can finish reviewing your claim. See Details Alert Warning Above affected component

Save your work in progress (for unauthenticated users) Sign in now to save time and save your work in progress Here’s how signing in now helps you: * We can fill in some of your information for you to save you time. * You can save your work in progress. You’ll have 60 days from when you start or make updates to your application to come back and finish it. Note: You can sign in after you start your application. But you’ll lose any information you already filled in. Sign in to start your application (primary button); Start your application without signing in (link) Alert box Informational After h1 on Form Introduction page

Prefill - Intro variation (for authenticated users) We’ve prefilled some of your information Since you’re signed in, we’ve prefilled part of your application based on your profile details. You can also save your application in progress and come back later to finish filling it out. None Alert box Informational After h1 on Form Introduction page