search

redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
80 stars 67 forks source link

issue-172 #174

Closed oraNod closed 2 years ago

oraNod commented 2 years ago

172

neal-timpe commented 2 years ago

Hi, @oraNod checking in from the CCS Accessibility team.

I'd include a sentence like this, which we're adding to the style guide:

Provide text equivalents for every diagram, image, or other non-text element. Avoid using images of text instead of actual text.

I agree with the sentence about avoiding screenshots. But, I don't agree that it needs to be a full sentence or include things like This illustration depicts. It is okay if it's not a full sentence partially because the context of the image element provides the context for a screen reader user that it's an image. I think asciidoc has a good reference about how to code it. And Harvard has a good reference about how to write effective alt text.

oraNod commented 2 years ago

Thanks @neal-timpe I've updated with that, much appreciated.

vsodhi commented 2 years ago

LGTM.