Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Aug 21, 2024
1 parent 307938f commit e244466
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions _guide/plain-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 isnt 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.

Expand All @@ -34,38 +34,38 @@ 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?

Check warning on line 34 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L34

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
  34:6-34:116  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
3. Use an active voice.
- The subject of a sentence should be performing an action.

Check warning on line 36 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L36

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   36:6-36:66  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- 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.

Check warning on line 37 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L37

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
  37:6-37:146  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
4. Write for your audience.
- People visit your website to do something. Before writing, identify the readers needs.
- How can you answer your readers top questions quickly?
- People visit your website to do something. Before writing, identify the reader's needs.

Check warning on line 39 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L39

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   39:6-39:96  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- How can you answer your reader's top questions quickly?

Check warning on line 40 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L40

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   40:6-40:63  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- What do readers need to know or do after reading your content?

Check warning on line 41 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L41

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   41:6-41:70  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
5. Make it scannable.
- Users dont 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.

Check warning on line 43 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L43

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   43:6-43:88  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- Structure your content with clear headers and present them in a logical order.

Check warning on line 44 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L44

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   44:6-44:86  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- Use short paragraphs, bullet points, and lists to sort content into smaller sections that are easier to read.

Check warning on line 45 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L45

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
  45:6-45:119  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
6. Dont use jargon.
6. Don't use jargon.
- Business and technical jargon can be confusing. Try to use common words in place of jargon.

Check warning on line 47 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L47

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   47:6-47:99  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- Spell out acronyms the first time one is used.

Check warning on line 48 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L48

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   48:6-48:55  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
7. Dont use idioms.
7. Don't use idioms.
- Idioms are only clear to people that are in a certain group.

Check warning on line 50 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L50

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   50:6-50:69  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- These can be confusing for someone whose first language isnt English.
- These can be confusing for someone whose first language isn't English.

Check warning on line 51 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L51

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   51:6-51:79  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- Try to use simple words in place of phrases.

Check warning on line 52 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L52

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
   52:6-52:53  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint

## Test your content

Now that youve written your content, its 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

Always run your content through a readability tool and try to get the reading grade level lower than 8th grade. Some common readability tools are:

- [Hemingway App](https://www.hemingwayapp.com/): This app highlights content that could be hard for your audience to read.

Check warning on line 62 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L62

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
  62:1-62:125  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- [Readable](https://readable.io/): This is a paid service that analyzes your content to identify its readability score, grammar errors, and style issues.

Check warning on line 63 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L63

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
  63:1-63:156  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint
- [Microsofts 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 contents 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.

Check warning on line 64 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L64

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
  64:1-64:251  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint

### 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:
- [Microsofts 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.

Check warning on line 68 in _guide/plain-language.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] _guide/plain-language.md#L68

Marker style should be `*` unordered-list-marker-style remark-lint
Raw output
  68:1-68:253  warning  Marker style should be `*`          unordered-list-marker-style  remark-lint

### 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:
Expand Down

0 comments on commit e244466

Please sign in to comment.