GNOME Bugzilla – Bug 519067
Improve accessibility documentation for users, developers, and system integrators
Last modified: 2021-06-06 12:17:45 UTC
This is a "GNOME Outreach Program: Accessibility" task that covers both gnome-devel-docs and gnome-user-docs. It is being places here as a means to track the progress. Please refer to the "TASK: Documentation" section of http://live.gnome.org/Accessibility/GOPA for detailed information on the task.
Note that an accessibility guide for developers has been on the wishlist for gnome-devel-docs for some time. See http://live.gnome.org/DeveloperGuides I'd be glad to help anybody working on such a guide, or on the current Accessibility Guide for users in gnome-user-docs. I'm certainly not the person to mentor, because I don't know the accessibility stuff well enough to help with content. But I can help with documentation-related issues (markup, style, etc.)
I'm not exactly sure of the format but I'd like to put in a proposal for this work. I know 2 of the panel already know me, but I'd like to give a little background: while I'm a developer and not formally trained in technical writing, I have been explaining and promoting Open Source and accessibility to users and hackers for some time, including efforts on fullmeasure.co.uk, www.oatsoft.org and schoolforge.org.uk. I recently wrote the Python/GNOME a11y article: http://live.gnome.org/Accessibility/PythonPoweredAccessibility I'm convinced that clear documentation is vital and the lack of it is a significant barrier, especially when people first approach GNOME a11y. My aim will be to clearly introduce the great a11y features of GNOME in enough depth while also providing jump off points for using GNOME a11y or contributing. As described in http://www.gnome.org/projects/outreach/a11y/tasks/documentation this is a BIG and rather open-ended task, plus the exchange rate with GBP is a killer. I therefore suggest a phased approach: 1) Review the current situation and create clear entry-point documentation as outlined in the task notes. Provide links to existing docs, reorganise and cull dead docs as required. The idea is to give a good starting point for anyone visiting the docs in a relatively short time and with clear signposts to the detailed documentation. 2) Scope the next phases based on what has been learnt from 1) 3) Detailed documentation in key areas identified from 1 and 2. A significant quantity of new content is to be expected. More detailed analysis of key projects and interviews with developers, distos and users will be critical here. It will be great to work with Shaun or any one else who would like to help out. Steve
I claim this task
Adding gnome-user-docs-maint to the CC list, as this affects user documentation as well. (Should we have a separate bug in gnome-user-docs?)
I *unclaim* this task :-) Vincent, have fun.
I haven't claimed "fun" in over 10 years - that's practically an endorsement for public office. :) Things are coming along pretty well and I welcome any suggestions, criticisms or other improvements to vpalexander@gmail.com - "If I Don't Do It, Someone Else Will!" Hehe.
*** Bug 564996 has been marked as a duplicate of this bug. ***
Closing as obsolete - if there are still specific issues, please follow https://wiki.gnome.org/GettingInTouch/BugReportingGuidelines and create a ticket in gitlab.gnome.org. Thanks a lot!