From e24446635a58aa4d472babb1d2ef912616a43b3a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 21 Aug 2024 21:47:00 +0000 Subject: [PATCH] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- _guide/plain-language.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/_guide/plain-language.md b/_guide/plain-language.md index 3110ab6e..ffa22ff5 100644 --- a/_guide/plain-language.md +++ b/_guide/plain-language.md @@ -19,7 +19,7 @@ roles: # Plain Language -Plain language helps make your content accessible by allowing your audience to quickly understand it the first time they interact with it. This helps people with different cognitive abilities, people whose first language isn’t English, and those that rely on audio to listen to text. +Plain language helps make your content accessible by allowing your audience to quickly understand it the first time they interact with it. This helps people with different cognitive abilities, people whose first language isn't English, and those that rely on audio to listen to text. Plain language means that your content is written as clear and simple as possible. Good plain language will help readers find what they need, understand it quickly, and use that information to meet their needs. @@ -34,26 +34,26 @@ Plain language means that your content is written as clear and simple as possibl - Imagine you're talking to your reader over the phone. What words would you use to answer questions directly? 3. Use an active voice. - The subject of a sentence should be performing an action. - - For example, “You need to submit the form online.” You, as the subject of the sentence, are performing the action by submitting the form. + - For example, "You need to submit the form online." You, as the subject of the sentence, are performing the action by submitting the form. 4. Write for your audience. - - People visit your website to do something. Before writing, identify the reader’s needs. - - How can you answer your reader’s top questions quickly? + - People visit your website to do something. Before writing, identify the reader's needs. + - How can you answer your reader's top questions quickly? - What do readers need to know or do after reading your content? 5. Make it scannable. - - Users don’t read, they scan. They often leave web pages within 10 to 20 seconds. + - Users don't read, they scan. They often leave web pages within 10 to 20 seconds. - Structure your content with clear headers and present them in a logical order. - Use short paragraphs, bullet points, and lists to sort content into smaller sections that are easier to read. -6. Don’t use jargon. +6. Don't use jargon. - Business and technical jargon can be confusing. Try to use common words in place of jargon. - Spell out acronyms the first time one is used. -7. Don’t use idioms. +7. Don't use idioms. - Idioms are only clear to people that are in a certain group. - - These can be confusing for someone whose first language isn’t English. + - These can be confusing for someone whose first language isn't English. - Try to use simple words in place of phrases. ## Test your content -Now that you’ve written your content, it’s important to test it! This can help you improve your content. You can test your content using readability tools, listening to your content read aloud, and conducting user testing with your audience. +Now that you've written your content, it's important to test it! This can help you improve your content. You can test your content using readability tools, listening to your content read aloud, and conducting user testing with your audience. ### Use a readability tool @@ -61,11 +61,11 @@ Always run your content through a readability tool and try to get the reading gr - [Hemingway App](https://www.hemingwayapp.com/): This app highlights content that could be hard for your audience to read. - [Readable](https://readable.io/): This is a paid service that analyzes your content to identify its readability score, grammar errors, and style issues. -- [Microsoft’s Flesch-Kincaid](https://support.microsoft.com/en-us/office/get-your-document-s-readability-and-level-statistics-85b4969e-e80a-4777-8dd3-f7fc3c8b3fd2): This can be used with Microsoft Word to calculate your content’s readability score. +- [Microsoft's Flesch-Kincaid](https://support.microsoft.com/en-us/office/get-your-document-s-readability-and-level-statistics-85b4969e-e80a-4777-8dd3-f7fc3c8b3fd2): This can be used with Microsoft Word to calculate your content's readability score. ### Use a text-to-speech reader Text-to-speech (TTS) is a type of assistive technology that takes words on a digital device and reads it aloud. Simply hearing text read aloud can help authors better understand where improvements can be made. We recommend this tool: -- [Microsoft’s Immersive Reader](https://support.microsoft.com/en-us/topic/use-immersive-reader-in-microsoft-edge-78a7a17d-52e1-47ee-b0ac-eff8539015e1): In Microsoft Edge, this mode has a Read Aloud tool that can be used to read the text of a web page. +- [Microsoft's Immersive Reader](https://support.microsoft.com/en-us/topic/use-immersive-reader-in-microsoft-edge-78a7a17d-52e1-47ee-b0ac-eff8539015e1): In Microsoft Edge, this mode has a Read Aloud tool that can be used to read the text of a web page. ### User testing with your audience Automated readability tools won't catch everything. You'll need to test your content with humans too. When user testing, you can: