Merge pull request #6017 from department-of-veterans-affairs/5985-details-plain-language

Apply plain language improvements to Details component guidance

Author: jeana-adhoc

src/_components/details.md

@@ -2,7 +2,7 @@
 layout: component
 title: Details
 status: use-with-caution-candidate
-intro-text: "Details makes content easier to scan as it hides information that may not be applicable to all users or situations. We use the Details component to situate plain language help at the point of the process where it is most relevant."
+intro-text: "The Details component reveals optional, supporting information that isn't required for most users to complete a task. It is used to provide plain language help at the point where it is most relevant."
 figma-link-web: https://www.figma.com/design/afurtw4iqQe6y4gXfNfkkk/VADS-Component-Library?node-id=42924-290
 uswds-v3: default
 web-component: va-details
@@ -12,7 +12,6 @@ uses_mermaid: true
 anchors:
   - anchor: Examples
   - anchor: Usage
-  - anchor: Behavior
   - anchor: Code usage
   - anchor: Content considerations
   - anchor: Accessibility considerations
@@ -24,68 +23,68 @@ anchors:
 
 ### Default
 
-{% include storybook-preview.html  story="components-va-details--default" link_text="va-details default" %}
+{% include storybook-preview.html story="components-va-details--default" link_text="va-details default" %}
 
 ### Different widths
-Use the Details component with a reduced width when you need the Details component to have less visual space on the page. 
+Use a reduced width when you need Details to take up less space on the page.
 
-{% include storybook-preview.html  story="components-va-details--widths" link_text="va-details widths" %}
+{% include storybook-preview.html story="components-va-details--widths" link_text="va-details widths" %}
 
 ## Usage
 
 ### When to use Details
 
-* **Revealing helpful background information**: When you have additional information you want to convey about an application, process, or a step or question in a form that is not critical. This component should be used in instances where a more prominent [Alert]({{ site.baseurl }}/components/alert) would not be appropriate.
-* **Clarifying outcomes for an input**: In cases where a person's input can have large or complicated impact on outcomes we use contextual help in Details to locate expanded guidance next to the relevant interaction.
-* **Information closely tied to an input.** Use this component over an [Accordion]({{ site.baseurl }}/components/accordion) when the content is closely tied to a particular message or input on the screen. If the content is more tangentially related then use an Accordion.
-* **Clarifying a form question**: If a form question needs clarification, and that clarification is brief, use Details. The lighter design prevents breaking up the visual progression as the user navigates the form. These can also serve as alternative to where accordions feel too heavy. Be sure to review the [hint text guidance]({{ site.baseurl }}/components/form/label#hint-text) for implementation details. If a form is a conversation, Details would be considered an aside. (This <a href="https://blog.navapbc.com/structuring-a-complex-eligibility-form-for-healthcare-gov-37d79a5ad6">case study on structuring complex health care questions for healthcare.gov</a> goes into greater detail on how to structure your form as a conversation.)
+* **Revealing helpful background information.** Use this component when you have additional information about an application, process, or form step that isn't critical. Use this component in instances where a more prominent [Alert]({{ site.baseurl }}/components/alert) wouldn't be appropriate.
+* **Explaining the impact of a choice.** If a user's answer will significantly affect their results or next steps, use Details to put that explanation right next to the relevant field.
+* **Information closely tied to an input.** Use this component over an [Accordion]({{ site.baseurl }}/components/accordion) when the content is closely tied to a particular message or input on the screen. If the content is only loosely related, use an Accordion instead.
+* **Clarifying a form question.** If a form question needs clarification, and that clarification is brief, use Details. The lighter design doesn't interrupt the flow of the form. These can also serve as an alternative when accordions feel too heavy or when hint text isn't enough. Be sure to review the [hint text guidance]({{ site.baseurl }}/components/form/label#hint-text) for more information.
 * **Content that can be organized under the current heading.** If you have additional content that provides context and makes sense under the same heading as the content nearby.
-* **Information not applicable to all**: Details can hide details that may not be applicable to all users.
+* **Information not applicable to all.** The Details component can hide information that doesn't apply to all users.
 
 ### When to consider something else
 
-* **Accordions for a series**: If you have a series of content in the body of a page and outside of a form or tool then an [Accordion]({{ site.baseurl }}/components/accordion) is preferred. For example, if you have a series of questions as part of an FAQ section or a set of options for payment that each have additional details.
-* **Too much content**: Only include critical information inside this component. This includes form fields that require a lot of explanation. Link to another page, consider an [Accordion]({{ site.baseurl }}/components/accordion), or shorten the content. Collaborate with a member of the Content and IA team to edit content and explore alternatives.
-* **Required content**: If the majority of people need the content to accomplish the main task then it should not be hidden from view.
-* **Content organized under a new heading.** If you have enough content that it makes sense to organize under a new heading that does not make sense under the same heading as the content nearby then use an [Accordion]({{ site.baseurl }}/components/accordion).
-* **Error messages or other immediate actions**: Do not use this component for error messages or other critical or timely information.
-* **Inside Alerts**: Use this component inside an [Alert]({{ site.baseurl }}/components/alert) only as a last resort and if approved in the Collaboration Cycle. Instead use the [Alert - Expandable]({{ site.baseurl }}/components/alert/alert-expandable) component, especially when the Alert is within the page content and not at the top of the page.
-* **Floating in space**: Try to avoid using Details outside of the flow of the page, unattached to a section of content or another component. For example, there are instances of Details between a h1 and a Card. See [placement](#placement) for more.
+* **Accordions for a series.** If you have a series of content in the body of a page and outside of a form or tool, use an [Accordion]({{ site.baseurl }}/components/accordion) instead. For example, a series of FAQ questions or a set of payment options that each have additional information.
+* **Too much content.** Only include critical information inside this component. This includes form fields that require a lot of explanation. Link to another page, consider an [Accordion]({{ site.baseurl }}/components/accordion), or shorten the content. Collaborate with a member of the Content and Information Architecture (IA) team to edit content and explore alternatives.
+* **Required content.** If most people need the content to accomplish the main task, don't hide it from view.
+* **Content organized under a new heading.** If the content warrants a new heading that doesn't belong under the same heading as nearby content, use an [Accordion]({{ site.baseurl }}/components/accordion) instead.
+* **Error messages or other immediate actions.** Don't use this component for error messages or other critical or timely information.
+* **Inside Alerts.** Use this component inside an [Alert]({{ site.baseurl }}/components/alert) only as a last resort and if approved in the Collaboration Cycle. Instead use the [Alert - Expandable]({{ site.baseurl }}/components/alert/alert-expandable) component, especially when the Alert is within the page content and not at the top of the page.
+* **Floating in space.** Try to avoid using Details outside of the flow of the page, unattached to a section of content or another component. See [placement](#placement) guidance on this page for more information.
 
 {% include content/details-vs-hint-text-vs-accordion.md %}
 
-## Behavior
+### How this component works
 
 The Details component uses native HTML `<details>` and `<summary>` elements, which provide several advantages over JavaScript-based implementations:
 
-* **Searchable and discoverable content**: Browser search (Ctrl+F or Cmd+F) can find text inside collapsed Details, and search engines can index the content for better search engine optimization (SEO).
-* **Better performance and reliability**: No JavaScript required for basic functionality, improving load times and ensuring content works even when JavaScript fails.
-* **Enhanced accessibility**: Native semantic meaning provides better assistive technology support without additional ARIA attributes, following web standards universally supported across browsers.
+* **Searchable and discoverable content.** Browser search (Ctrl+F or Cmd+F) can find text inside collapsed Details, and search engines can index the content for better search engine optimization (SEO).
+* **Better performance and reliability.** This component requires no JavaScript for basic functionality, improving load times and ensuring content works even when JavaScript fails.
+* **Enhanced accessibility.** Native semantic meaning provides better assistive technology support without additional ARIA attributes, following web standards universally supported across browsers.
 
 ### Placement
 
-The following are places where Details can be used:
+You can use Details in these places:
 
-* After a header (h2, h3, h4) or paragraph to provide orthogonal details or provide an answer to a common question.
-* Within a [Process list]({{ site.baseurl }}/components/process-list) to shorten the length of content within a step.
-* Within, or at the end, of a [Form]({{ site.baseurl }}/components/form/label#with-details) to provide additional help text. 
-* Whenever there is a chance to enhance the understanding a user has about a particular choice.
+* After a header (h2, h3, or h4) or paragraph to provide supplementary information or answer a common question
+* Within a [Process list]({{ site.baseurl }}/components/process-list) to shorten the length of content within a step
+* Within, or at the end, of a [Form]({{ site.baseurl }}/components/form/label#with-details) to provide additional help text
+* When you need to help users understand a particular choice
 
-**Note:** Placement does not alter [content considerations](#content-considerations) in any way.
+**Note:** Placement of Details doesn't change the [content considerations](#content-considerations) for this component.
 
 {% include component-docs.html component_name=page.web-component %}
 
 ## Content considerations
 
-* **Use a statement, rather than a question.** Use a statement (like "Why we ask for this information") rather than a question (like "Why does VA ask for this information?") for the title (trigger text) of the component. Because we use questions to gather information from people in our forms, structuring additional information as questions as well can cause confusion. Keep titles to a single sentence or sentence fragment with no ending punctuation.
-* **Limit the amount of expanded content.** Limit content to fewer than 500 characters (with spaces) when possible. If you need to provide more information, consider using one or more [Accordions]({{ site.baseurl }}/components/accordion) instead or providing a brief overview in the Details component with a link to another page with more information. Collaborate with a member of the Content and Information Architecture team to edit content and explore alternatives.
-* **Use lists in expanded content as needed.** To make content easier to scan, we encourage you to use numbered (also called "ordered") and bulleted (also called "unordered") lists as needed.
+* **Use a statement, rather than a question.** Use a statement (like "Why we ask for this information") rather than a question (like "Why does VA ask for this information?") for the label of the component. Framing help text as questions can confuse people who expect questions to ask for their input. Keep titles to a single sentence or sentence fragment with no ending punctuation.
+* **Limit the amount of expanded content.** Limit content to fewer than 500 characters (with spaces) when possible. If you need to provide more information, use 1 or more [Accordions]({{ site.baseurl }}/components/accordion) instead. You can also include a brief overview in Details with a link to a page that has more detail. Collaborate with a member of the Content and Information Architecture team to edit content and explore alternatives.
+* **Use lists in expanded content as needed.** Use numbered (ordered) and bulleted (unordered) lists to make content easier to scan.
 
 ## Accessibility considerations
 
-* **Wrap content in HTML elements.** All text content inside `va-details` must be wrapped in an appropriate HTML element such as `<p>`, `<span>`, or `<div>`. Some screen readers, particularly NVDA, may ignore unwrapped plain text. For example, use `<p>This is the content.</p>` instead of placing text directly inside the component without a wrapper element.
-* **Do not add ARIA roles or state attributes.** The details component uses the `<details>` HTML element that exposes expanded/collapsed state and interactive behavior natively. Adding any `role="button"` or `aria-expanded` is redundant and can create conflicting announcements in assistive technology.
-* **Keyboard interaction is provided natively.** Users must be able to tab to the component, toggle it using Enter or Space, and if there are interactive elements in the component, the next tab takes them to those interactive elements.
+* **Wrap content in HTML elements.** Place all text content inside `va-details` within an appropriate HTML element such as `<p>`, `<span>`, or `<div>`. Some screen readers, particularly NVDA, may ignore unwrapped plain text. For example, use `<p>This is the content.</p>` instead of placing text directly inside the component without a wrapper element.
+* **Don't add ARIA roles or state attributes.** The Details component uses the `<details>` HTML element that exposes expanded/collapsed state and interactive behavior natively. Adding any `role="button"` or `aria-expanded` is redundant and can create conflicting announcements in assistive technology.
+* **Native keyboard interaction.** Users can tab to the component and toggle it open or closed with Enter or Space. If the component contains interactive elements, the next Tab keypress moves focus to those elements.
 
 ## Related
 

src/_includes/content/details-vs-hint-text-vs-accordion.md

@@ -2,11 +2,11 @@
 
 When deciding which component to use inside a form, consider how essential the information is and how it relates to nearby content:
 
-* **Essential information for form fields:** Use {% if page.url == '/components/form/label' %}hint text{% else %}[hint text]({{ site.baseurl }}/components/form/label#hint-text){% endif %} for brief, critical information that most users need to complete a field successfully.
-* **Helpful context tied to specific content:** Use {% if page.url == '/components/details' %}Details{% else %}[Details]({{ site.baseurl }}/components/details){% endif %} for brief explanations related to nearby form fields or sections that users can access when needed.
-* **Substantial standalone information:** Use {% if page.url == '/components/accordion' %}Accordion{% else %}[Accordion]({{ site.baseurl }}/components/accordion){% endif %} for lengthy content that deserves its own heading or multiple related topics like FAQ sections.
+* **Essential information for form fields.** Use {% if page.url == '/components/form/label' %}hint text{% else %}[hint text]({{ site.baseurl }}/components/form/label#hint-text){% endif %} for brief, critical information that most users need to complete a field successfully.
+* **Helpful context tied to specific content.** Use {% if page.url == '/components/details' %}Details{% else %}[Details]({{ site.baseurl }}/components/details){% endif %} for brief explanations related to nearby form fields or sections that users can access when needed.
+* **Substantial standalone information.** Use {% if page.url == '/components/accordion' %}Accordion{% else %}[Accordion]({{ site.baseurl }}/components/accordion){% endif %} for lengthy content that deserves its own heading or multiple related topics like FAQ sections.
 
-### Decision tree
+#### Decision tree
 
 <div class="mermaid-width mermaid-comparison">
   <div class="sr-only">
@@ -43,25 +43,27 @@ flowchart TD
 
 <h4>Text-based decision guide</h4>
 
-<ol>
+<ol style="font-size:1rem;">
+<!-- fontsize defined because the details component is resizing this text to 16.96px -->
+
 <li><strong>Is this information essential for completing a form field?</strong>
     <ul>
-    <li><strong>Yes</strong> (Field requirements, input patterns) → <em>Use hint text</em></li>
+    <li><strong>Yes</strong> (Field requirements, input patterns) → Use hint text</li>
     <li><strong>No</strong> (Background context, helpful clarifications) → Continue to question 2</li>
     </ul>
 </li>
 
 <li><strong>Is content related to a nearby form field or section?</strong>
     <ul>
     <li><strong>Yes</strong> (Why we ask questions, field-specific help) → Continue to question 3</li>
-    <li><strong>No</strong> (General information, standalone topics) → <em>Use Accordion</em></li>
+    <li><strong>No</strong> (General information, standalone topics) → Use Accordion</li>
     </ul>
 </li>
 
 <li><strong>Is content brief and doesn't need a heading?</strong>
     <ul>
-    <li><strong>Yes</strong> (Short explanations, simple clarifications) → <em>Use Details</em></li>
-    <li><strong>No</strong> (Long content, complex explanations) → <em>Use Accordion</em></li>
+    <li><strong>Yes</strong> (Short explanations, simple clarifications) → Use Details</li>
+    <li><strong>No</strong> (Long content, complex explanations) → Use Accordion</li>
     </ul>
 </li>
 </ol>

src/assets/stylesheets/application.scss

@@ -248,7 +248,6 @@ these can be removed along with an update to how classes are generated in color-
 }
 
 .mermaid-chart-caption {
-  font-style: italic;
   text-align: center;
   max-width: 768px;
   margin: 0 auto;