Page MenuHomePhabricator

Ensure Topic Container code adheres to technical standards and best practices
Closed, ResolvedPublic

Description

🧪 The Editing Team is serving as beta testers of the Product Development Best Practices Playbook by applying it to the Usability Improvements portion of the Talk Pages Project. This task represents doing work the playbook specifies in its DEVELOP step.


T282261 will contain the designs for the Topic Container user experience we will be implementing to start.

In line with the Product Development Best Practices Playbook, after implementing the Topic Container user experience, it is important that we ensure the code we'e written to implement the Topic Container user experience adheres to accessibility technical standards and engineering best practices described in the following:

Evaluation

Wikimedia Engineering Architecture Principles
Requirement NameDescriptionRequirement Met? (Y/N)Notes

https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label

Web Content Accessibility Guidelines (WCAG) Requirements
DescriptionRequirement Met? (Y/N)Notes
All actions are keyboard accessible, with appropriate ARIA labelsY
All information is visible to screen readersYWe added some content inside the topic <h2>, which may not be ideal, however there is precedence with section edit links, and this was the only viable technical solution (T314714)
Any non-OOUI components meet accessibility guidelines (colour contrast, ARIA labels, keyboard accessibility)Y

Open questions

  • Which of the Web Content Accessibility Guidelines (WCAG) Requirements will we commit to meeting? Who will evaluate the extent to which a requirement has been met? How will this person/group of people evaluate the extent to which a requirement has been met?
    • Per T296354#7953468, we're going to prioritize ensuring:
      • All actions are keyboard accessible, with appropriate ARIA labels
      • All information is visible to screen readers
      • Any non-OOUI components meet accessibility guidelines (colour contrast, ARIA labels, keyboard accessibility)
    • The Editing Engineering Team will evaluate the extent to which the conditions above have been met
    • The three conditions above are objective enough for us not to need to depend on subjective judgement...the expect it to be obvious whether the three conditions have been met.
  • Who will evaluate the extent to which the Wikimedia Engineering Architecture Principles have been met? How will this person/group of people evaluate the extent to which these principles have or have not been been met?

Done

  • All ===Open questions are answered
  • The outcome of the Wikimedia Engineering Architecture Principles and Web Content Accessibility Guidelines (WCAG) Requirements evaluations are documented in the === Evaluation section

Event Timeline

ppelberg moved this task from Untriaged to Upcoming on the Editing-team board.
ppelberg moved this task from Backlog to Triaged on the DiscussionTools board.

Editing engineering are proposing the following guidelines:

  • Ensure all actions are keyboard accessible, with appropriate ARIA labels
  • Ensure important information is visible to screen readers
  • Ensure any non-OOUI components meet accessibility guidelines (colour contrast, ARIA labels, keyboard accessibility)

Editing engineering are proposing the following guidelines

@Esanders what y'all converged on T296354#7953468 sounds good to me as it relates to accessibility. I've updated the task description to reflect this.

Regarding Wikimedia Engineering Architecture Principles, did y'all talk about/decide on what checks we'll follow to ensure these principles are met?

@Esanders: would it be accurate for me to interpret the assessment you made in T296354#8141052 as the completion of this review?

@Esanders: would it be accurate for me to interpret the assessment you made in T296354#8141052 as the completion of this review?

Yes