From fee2e20ac5defdf8014f1d36b9ac1ad57583de21 Mon Sep 17 00:00:00 2001 From: Megan Zehnder <72934749+megzehn@users.noreply.github.com> Date: Thu, 25 Jul 2024 11:02:28 -0400 Subject: [PATCH 1/2] Create forms.md Getting a very rough draft started for a form content brief --- .../specific-topics-and-programs/forms.md | 79 +++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 src/_content-style-guide/specific-topics-and-programs/forms.md diff --git a/src/_content-style-guide/specific-topics-and-programs/forms.md b/src/_content-style-guide/specific-topics-and-programs/forms.md new file mode 100644 index 000000000..8277a5688 --- /dev/null +++ b/src/_content-style-guide/specific-topics-and-programs/forms.md @@ -0,0 +1,79 @@ +--- +layout: content-style-guide +permalink: /content-style-guide/specific-topics-and-programs/forms +has-parent: /content-style-guide/specific-topics-and-programs/ +title: Forms +intro-text: "The information on this page will help you use consistent language patterns in VA forms." + - anchor: Considerations + - anchor: Patterns + - anchor: Resources +--- + +## Considerations + +- As with all content on VA, we use clear, conversational language in digital forms. This complies with the Plain Writing Act of 2010 and the 21st Century Integrated Digital Experiences Act (21st Century IDEA). Learn more about legal considerations in the [plain language vs. legalese section of the design system](https://design.va.gov/templates/forms/#legalese-vs-plain-language). +- The teams who digitize forms are responsible for getting the language vetted and checked by the specific form subject matter experts. + +**Note:** If you're looking for guidance on a specific form label, error message, or hint text, links to updated labels are in the [Form labels section](https://design.va.gov/content-style-guide/form-labels). These labels are guidance for a standard version. The specific labels you use may depend on the specific form you're working on and the subject matter experts you're working with. + +## Patterns + +### Voice + +Use active voice. In general, use second person questions with first person responses. + +Example: + +What caused this service-connected disability? + +(radio button) My disability was caused by an injury or exposure during my military service. +(radio button) My disability was caused by an injury or exposure during training. + +### Yes or no questions + +- In most cases, there should be 2 answer options for Yes and No questions: "Yes" and "No" +- In certain cases, you can have up to 4 answer options: "Yes," "No," "I don't know," and "I prefer not to answer" +- Don't restate the question wording in the answer options + +Like this: Is the Veteran deceased? Yes [button] No [button] +Not like this: Is the Veteran deceased? Yes, the Veteran is deceased [button] No, the Veteran is not deceased [button] + +### Punctuation + +Don't use punctuation in these instances: + +Step titles +Example: Veteran personal information + +Headers +Example: "Veteran's identification information" or "Tell us where we should send the information" would not have punctuation. + +Error messages +Example: Enter a 10-digit phone number (with or without dashes) + +Standard labels +Example: "Name" or "Phone number" + +Responses on multiple choice +Example: I'm the Veteran's spouse + +Additional info components +Example: Learn more about military base addresses + +Hint text +Example: You may request up to 99 certificates + +CTA links +Example: Find out if you're eligible (opens in new tab) + +**Exceptions** + +Normal body text uses standard punctuation. Example: We don't require that you submit anything with this form. + +Add a question mark if the content is a question. Example: "Are you the Veteran?" + +Use punctuation if the content is more than one full sentence. Example: "Select the responses that describe your living situation. You can select more than one." + +## Resources + +- [Legalese vs. plain language](https://design.va.gov/templates/forms/#legalese-vs-plain-language) From fbb8455c7bfc9bd5241c000bf151a86e923889d4 Mon Sep 17 00:00:00 2001 From: Megan Zehnder <72934749+megzehn@users.noreply.github.com> Date: Thu, 25 Jul 2024 14:14:37 -0400 Subject: [PATCH 2/2] Update forms.md formatting --- .../specific-topics-and-programs/forms.md | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/src/_content-style-guide/specific-topics-and-programs/forms.md b/src/_content-style-guide/specific-topics-and-programs/forms.md index 8277a5688..fa34e4a2b 100644 --- a/src/_content-style-guide/specific-topics-and-programs/forms.md +++ b/src/_content-style-guide/specific-topics-and-programs/forms.md @@ -18,26 +18,6 @@ intro-text: "The information on this page will help you use consistent language ## Patterns -### Voice - -Use active voice. In general, use second person questions with first person responses. - -Example: - -What caused this service-connected disability? - -(radio button) My disability was caused by an injury or exposure during my military service. -(radio button) My disability was caused by an injury or exposure during training. - -### Yes or no questions - -- In most cases, there should be 2 answer options for Yes and No questions: "Yes" and "No" -- In certain cases, you can have up to 4 answer options: "Yes," "No," "I don't know," and "I prefer not to answer" -- Don't restate the question wording in the answer options - -Like this: Is the Veteran deceased? Yes [button] No [button] -Not like this: Is the Veteran deceased? Yes, the Veteran is deceased [button] No, the Veteran is not deceased [button] - ### Punctuation Don't use punctuation in these instances: @@ -74,6 +54,26 @@ Add a question mark if the content is a question. Example: "Are you the Veteran? Use punctuation if the content is more than one full sentence. Example: "Select the responses that describe your living situation. You can select more than one." +### Voice + +Use active voice. In general, use second person questions with first person responses. + +Example: + +What caused this service-connected disability? + +(radio button) My disability was caused by an injury or exposure during my military service. +(radio button) My disability was caused by an injury or exposure during training. + +### Yes or no questions + +- In most cases, there should be 2 answer options for Yes and No questions: "Yes" and "No" +- In certain cases, you can have up to 4 answer options: "Yes," "No," "I don't know," and "I prefer not to answer" +- Don't restate the question wording in the answer options + +Like this: Is the Veteran deceased? Yes [button] No [button] +Not like this: Is the Veteran deceased? Yes, the Veteran is deceased [button] No, the Veteran is not deceased [button] + ## Resources - [Legalese vs. plain language](https://design.va.gov/templates/forms/#legalese-vs-plain-language)