Requesting info/experiences: software engineering and web documentation for the blind/low-vision

gala_water
2023-11-06T22:25:43Z

I'm a technical writer. My company sells DevOps software mostly operated on the command line. I'm responsible for explaining this software via HTML5 documentation on our website.

One of our largest customers employs at least one software developer who is "totally blind" and requires a screen reader to work. I assume others exist, but they have not contacted us. Unfortunately, our website is not 100% ADA-compliant. It's far from the worst I've seen, but it could be a lot better.

I'm familiar with high-level web accessibility paradigms and am currently doing an informal audit of our website to determine what we need to improve to make it fully ADA-compliant. I've prioritized discovery for accessibility concerns in our next sprint. Eventually, I'd like to look into hiring a consultant to do a more robust analysis, but only if necessary because I'd need to request funding. Unfortunately, I have limited control over the text that displays in our product, just the documentation. Long-term, I'd like to collaborate with the product team to ensure our CLI is fully ADA-compliant.

I've begun reading web accessibility materials from the government. In the meantime, I wanted to ask: are any of you blind or low-vision, or have you used screen readers in the past? Or do you know any blind/low-vision devs? Either way, can you provide any personal insight into any of the things I can do as a technical writer to improve the usability of software documentation for the purpose of enabling you to do your job? My goal is to make the documentation experience great for screen reader users, not just OK.

Comments URL: https://tildes.net/~comp/1bxb/requesting_info_experiences_software_engineering_and_web_documentation_for_the_blind_low_vision

Votes: 18

Comments: 5