Skip to content

Latest commit

 

History

History
113 lines (65 loc) · 3.89 KB

_proposal-template.md

File metadata and controls

113 lines (65 loc) · 3.89 KB
Raw

[COMPONENT_NAME] proposal

1. About this component

1.1 Component name

Suggest a name (or names) for this component.

  • Does this component have a common name?
  • Are there any alternative names for this component?

1.2 Description

Describe the component in one sentence.

1.3 Design system need

Explain the need for this component.

  • What gap does this component fill in the design system? How is this different from existing USWDS components?
  • What problem does this component solve?
  • Does this component directly support any federal laws, guidance, or policies?

1.4 Component design

Give a detailed description of the functionality of the component. Include information about how it addresses the needs listed in section 1.3.

1.4.1 Core functionality

Describe the component's core functionality.

1.4.2 Interactive states (Optional)

If the component is dynamic, describe its interactive states.

1.4.3 Possible variants (Optional)

Identify possible variants for this component.

1.4.4 Demonstration (Optional)

Add diagrams, images, wireframes, and/or prototypes that visually demonstrate the component.

1.5 Implementation examples

Provide a list of links to examples of this kind of component on government (preferred) or non-government sites.

1.6 Related USWDS components

Identify any existing USWDS components connected to this one.

  • Are there any other components that this component would affect or replace?
  • Does this component depend on other USWDS components?

1.7 Key audiences

Identify any key audiences associated with this component.

  • Is this component designed for a specific audience?
  • Is there an audience that has a unique ability to determine if this component is successful?

2. Usage

2.1 When to use this component

Define the appropriate use cases for this component.

  • What common interactions does this component support?
  • What does this component need to do to be successful and effective?
  • What kind of content would be ideal for this component?

2.2 When to consider something else

Identify the scenarios where this component would not be the appropriate choice.

  • Are there common ways this type of component is misused?
  • Are there similar interactions that would be better supported by other components?
  • What kind of content should teams not use with this component?

3. Usability and accessibility

3.1 Usability considerations

Identify any key usability considerations. When possible, provide supporting links to research findings or supporting evidence (your own or other research).

  • What does this component need to do to be successful and effective?
  • What are the characteristics of a successful interaction with this component?
  • What would make this component less usable?
  • What are common pitfalls or implementation mistakes associated with this component?
  • How might the mobile context affect how you use this component?

3.2 Accessibility considerations

Identify any key accessibility considerations. When possible, provide supporting links to research findings or supporting evidence (your own or other research).

  • Will users of any assistive technologies struggle with this component? List any potential risks for users of keyboard navigation, screen readers, zoom magnification, voice command, etc.
  • Are there any other audiences that might struggle with this component?
  • Describe how this component might become inaccessible.

4. Stakeholders

4.1 Volunteers

Tag any volunteers who are willing to help design, develop, or test this component. Include details about their roles.

4.2 Endorsements

If there is significant support from a given agency or group, include their names here and tag any stakeholders.

4.3 Contributors

Share a list of those who helped carry out the research and work to prepare this proposal. Include your name and/or GitHub username if you'd like credit as a contributor.