Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Accessibility Best Practices for Developers #3342

Open
17 tasks
SamiyahKey opened this issue Jan 14, 2025 · 0 comments
Open
17 tasks

Document Accessibility Best Practices for Developers #3342

SamiyahKey opened this issue Jan 14, 2025 · 0 comments
Assignees
Labels
accessibility pertains to Section 508 compliance or other accessibility needs design issue is for the design team

Comments

@SamiyahKey
Copy link

Story

As a designer, I want to document accessibility best practices for developers so that they can implement designs that meet WCAG 2.1 AA standards and create inclusive user experiences.

This documentation plays a key role in ensuring that accessibility considerations are integrated into the development process moving forward. By documenting best practices, developers have clear guidance on how to build accessible components and layouts that align with the design intent and accessibility standards.

Acceptance Criteria

  1. Component Documentation:
  • Provide clear guidance on how each component should be implemented with accessibility in mind.
  • Include examples of semantic HTML for components like buttons, modals, and navigation menus.
  • Specify appropriate ARIA roles and attributes for components when needed.
  1. Focus Management:
  • Document expected focus states for interactive elements, including visual focus styles and keyboard navigation patterns.
  • Include guidance for managing focus within dynamic components (e.g., modals or accordions).
  1. Color and Contrast:
  • Provide accessible color palettes with sufficient contrast ratios for text, background, and interactive elements.
  • Specify requirements for contrast compliance, including a 4.5:1 ratio for text and non-text contrast.
  1. Text and Typography:
  • Include recommendations for font size, line height, and letter spacing for readability.
  • Ensure guidance for resizing text up to 200% without loss of content or functionality.
  1. Image and Media Usage:
  • Specify when and how to include alternative text for images.
  • Provide guidance for captions and transcripts for multimedia content.
  1. Responsive Design:
  • Ensure documentation includes breakpoints and guidance for designing accessible layouts at different screen sizes.
  • Highlight considerations for touch targets and gesture-based interactions.
  1. Error States and Validation:
  • Document best practices for accessible error messaging, including text descriptions and ARIA live regions.
  • Include guidance on form validation and error recovery.
  1. Testing Instructions:
  • Recommend tools for accessibility testing (e.g., Axe, Lighthouse).
  • Include instructions for manual testing using screen readers like NVDA or VoiceOver.

Additional Context

No response

Issue Links

No response

@SamiyahKey SamiyahKey added design issue is for the design team story User stories labels Jan 14, 2025
@SamiyahKey SamiyahKey self-assigned this Jan 14, 2025
@lizpearl lizpearl mentioned this issue Jan 14, 2025
3 tasks
@PaulKuykendall PaulKuykendall added accessibility pertains to Section 508 compliance or other accessibility needs and removed story User stories labels Jan 27, 2025
@PaulKuykendall PaulKuykendall moved this from 👶 New to 🍦 Backlog in .gov Product Board Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility pertains to Section 508 compliance or other accessibility needs design issue is for the design team
Projects
Status: 🍦 Backlog
Development

No branches or pull requests

2 participants