Scan for readability during accessibility scans
Problem to solve
As a developer of a text heavy site, I want to understand how readable my docs/pages/content is, so I can be confident my words make sense and are easy for my audience to understand.
Intended users
- Sasha (Software Developer) - who is updating docs / text as part of a project.
- Parker (Product Manager) - who is contributing to a user guide written in markup.
User experience goal
The user should be able to use the UI to see a readability score of text in their application after adding the accessibility template to their project.
Proposal
- It looks like pa11y supports WCAG2AAA if we enable that option but there could be a lot more scanning happening along with getting readability data in the report.
- Another approach may be to add another tool and strip out a single value like FleschReadingEase which Tech Writing is already using.
Further details
- Easier to read English text ends up being translated into more readable text.
Permissions and Security
None.
Documentation
- Add documentation to the Accessibility Testing docs about how to enable and/or use this feature.
Availability & Testing
What does success look like, and how can we measure that?
Success Metrics
- Within 90 days of launch of this feature can GitLab will utilize it in someway to measure the improved readability of text changes (docs, handbook, other)
What is the type of buyer?
IC
Is this a cross-stage feature?
No.