Description
openedon Feb 5, 2021
In one of the past JupyterLab accessibility meetings we received feedback that not only do accessibility-specific docs help people better use software, but that some users decide whether or not to even try using a piece of software based on whether or not there is an accessibility section to its docs. Since documentation is often left as the last step of our process and it sounds like this might be more important than we anticipated, I wanted to bring it up now.
I haven’t found accessibility-specific docs on any Jupyter project, so I don’t think we have best practices for these types of docs. I’m also betting that we will run into questions we haven’t with the general docs and will find answers worth recording.
This issue is open for discussion! Some ideas of what I think might be helpful are:
- Existing accessibility docs we can use as examples
- General accessibility docs best practices
- General accessible writing practices
- Proposed organization/headers (should it be sorted by user need? by whether or not an assistive device is used? etc.)
- Anything else you come across that ties together accessibility, writing, and documentation!
Full transparency, I spend my time around Jupyter almost exclusively on JupyterLab at the moment but I thought this topic might be helpful to projects across our community.
Shared by @trallard
- Someone recommended this article in a Discord for OSS https://letters4sneha.medium.com/the-tech-writers-journal-7-creating-accessible-documentation-eb2c011ac83c
- I also found this guides from opendocs to do audits for documentation maturity and completeness https://github.com/google/opendocs/tree/main/audit