wagtail / guide

A website to teach Wagtail CMS to content editors, moderators and administrators.
https://guide.wagtail.org
BSD 3-Clause "New" or "Revised" License
32 stars 26 forks source link

Wagtail User Interface Accessibility Features Documentation #324

Closed ArafatAbdussalam closed 1 year ago

ArafatAbdussalam commented 1 year ago

This issue is a WIP

An Authoring tool is classified to be accessible only if it satisfies either level A, AA or AAA success criterion of the Authoring Tool Accessibility Guideline (ATAG 2.0). A required practice is that the features of the interface of the Authoring Tool is understandable to the authors who have accessibility needs and that has led me to participate in the Wagtail Accessibility Project. My interest in Accessibility aligns with the Wagtail Accessibility consideration for web content authors. Having gained experience using Wagtail as an editor and researched my findings by interacting with the interface, these are my suggested accessibility features documentation needs:

Checklists

ArafatAbdussalam commented 1 year ago

Observation 1: Author

ArafatAbdussalam commented 1 year ago

My first authoring session was not quite smooth. One of the experience I had was the lack of understanding of the authors' checkbox. I did not understand how to add my name as an author. This is partly because it was not documented on the user guide.

My documentation suggestion:

Add to Authors' list of name

Authors are individuals who create web contents. During the editing session, it is important that you include your name as an author. To do this, take the following steps:

thibaudcolas commented 1 year ago

@ArafatAbdussalam please focus on more specific issues, this is way too broad as it is. There is also a fundamental need for you to understand Wagtail more before you report documentation gaps; both the things you pointed to aren’t Wagtail features per se (they’re site-specific customisations), so wouldn’t be documented as-is.

ArafatAbdussalam commented 1 year ago

Hi @thibaudcolas Thank you for the feedback. Initially, when I started this issue, I intended to make it be a summary of all issues I will be opening and append the links to the issues.

The comment below it was a draft. At the time of writing the comment, I was still familiarising myself with the admin interface and how to structure the documentation.

I will appreciate your feedback on the issue I have just opened and documented better Issue #338