-
Notifications
You must be signed in to change notification settings - Fork 34
Template (feature)
Dustin Nielsen edited this page Oct 21, 2024
·
1 revision
- A descriptive name for the feature
- State which epic this feature is a part of
- A brief overview of what the feature does
- Describe what the feature includes
- Mention any exclusions or aspects no included in this release
- List any other Epics or Features this work depends on and describe why the dependency exists
- List any external dependences (eg. dependent on other teams or external libraries)
- List any risks that could affect the timelines or outcome of this work
- Details about keyboard navigation for this feature
- Screen reader verification: Note which screen readers were tested and their versions
- Browser support: List the browsers supported by this feature and their respective versions
- Device support: Describe the device compatibility (mobile, desktop, etc...)
- State which HTML roles were used (if any)
- Additional ARIA code included with its purpose and function
- Include the package versions where the feature will be released
- Include whether documentation will be created for the design system website. If documentation differs from the standard pattern, this should be noted (eg. omitting contextual examples)
- Breaking changes should be specifically called out and likely have additional documentation created
- Compatibility notes (eg. versions of Angular and/or React)
- Larger changes to the system may require more modes of communication and/or additional documentation