diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 350451736856cb9b82b674d1632b9deab553a387..700a7ef56cf0a6d8d6c15559d615bf35e9693670 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -1280,7 +1280,7 @@ if you were helping someone read and interact with the page and they couldn't se Do: -`` +`` Do not: @@ -1292,14 +1292,13 @@ When writing alt text: typically stop reading after this amount. - If the image has complex information, like a workflow diagram, use a short alt text to identify the image and include detailed information in the text. -- Use complete sentences. -- Use punctuation. -- Use sentence case and avoid using all-caps. Some screenreaders read capitals as individual letters. +- Use end punctuation. +- Use sentence case and avoid using all-caps. Some screen readers read capitals as individual letters. - Don't use phrases like **Image of** or **Graphic of**. -- Don't use a string of keywords. Include keywords in a complete sentence to enhance context. +- Don't use a string of keywords. Include keywords in phrases or sentences to enhance context. - Introduce the image in the section text, not the alt text. - Try to avoid repeating content that you've already used in the section text. -- Don't use inline styling, like bold, italics, or backticks. Screen readers will read `**text**` as `star star text star star`. +- Don't use inline styling, like bold, italics, or backticks. Screen readers read `**text**` as `star star text star star`. #### Automatic screenshot generator