Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add alt text help article #17

Merged
merged 1 commit into from Jun 30, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions User-Help/AltText.md
@@ -0,0 +1,21 @@
## How to write good alt text

### What is alt text and why should I care about it?

Alt text, or an image description, is what shows up in place of an image when that image fails to load. It's also what a screen reader will read out when someone is using a screen reader to browse the site, as well as what search engines and feeds display. With that in mind, it's an important part of [web accessibility](https://webaim.org/) to include good alt text.

### How do I write good alt text?

Everything depends on the context of the image, but there are a few basic guidelines to keep in mind.

* **The alt text should serve the exact same purpose as the image**

When you're using an image, it's almost always to serve a purpose. Whether that's for demonstration, or to show an example, you're including an image for a reason.
The alt text should serve the exact same purpose in your post as the image. Anything that's important and *relevant to your post* that's contained in your image should also be contained in the alt text.

* **Don't include unnecessary or redundant details**

If you've already stated something in the text of your post, there's usually no need to repeat it in the alt text.
Don't get bogged down trying to include *every bit of detail* in the image. Only include whatever details from the image are actually relevant to your post - focus on the important parts.

As a general rule, if it would be theoretically possible for you to entirely replace your image with the alt text, without your post losing usefulness or clarity, you're good to go.