Skip to content

Latest commit

 

History

History
116 lines (92 loc) · 4.03 KB

proposal-template.md

File metadata and controls

116 lines (92 loc) · 4.03 KB
Raw

Summary*

Provide a short paragraph or bulleted list that gives an overview of the proposed component.

Motivation*

Explain why we should include this component in USWDS.

  • What user need does this component address?
  • What problem does this component solve?

Proposed solution*

Thoroughly describe the proposed component. Use the following sections to add detail:

Functionality*

Describe the component's core functionality. If the component is dynamic, describe its interactive states.

Diagrams*

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

Variants*

Describe any variants needed for this component.

Accessibility

Identify any accessibility considerations.

  • Will the component be compatible with assistive technologies?
  • Are there any audiences that might struggle with this component?

Implementation plan

Add details about how this plan should be implemented.

  • Will the component be implemented in phases?
  • Are there any potential blockers?
  • Are there any dependencies?

Testing plan

Explain how to test this component.

  • What kinds of tests will need to be performed?
  • Which elements and/or interactions will need to be tested?
  • Are there any specific audiences that should be included in user testing?

Documentation

Identify any documentation updates.

Supporting evidence

Provide links to any compelling research or other findings that support this proposal.

Potential drawbacks and alternatives considered

Share why we should NOT pursue this proposal.

  • How does the estimated level of effort compare with the expected benefit?
  • Are there any audiences that might find it difficult to use this component?
  • Are there any complications with using assistive technologies?

Explain which alternatives you have considered and explain their advantages and disadvantages.

  • Why did you choose the proposed solution over other possibilities?

Unknowns

Identify any questions that need to be answered before approving this proposal.

References (Optional)

List any resources used to help create this proposal.

Community support (Optional)

If there are any volunteers who are willing to help design, develop, or test this component, tag them here.

Endorsements (Optional)

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

Acknowledgements (Optional)

Thank those who have helped carry out this research and work.