Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions guidelines/groups/text-and-wording.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"children": [
"text-appearance",
"text-to-speech",
"clear-meaning",
"simplified-written-content"
"clear-language"
]
}
48 changes: 48 additions & 0 deletions guidelines/groups/text-and-wording/clear-language.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
children:
- clear-structure
- short-blocks-of-text
- sentence-structure
- common-words
- abbreviations
- non-literal-language
- verb-tense
- numerical-supplements
- unambiguous-numerical-formatting
- visual-aids
- summaries
- topic-sentence
- unambiguous-pronunciation
- review-process
- style-guide
- training-policy
status: developing
---

Users can understand the content without having to process complex or unclear language.

:::ednote
This guideline will include exceptions for poetic, scriptural, artistic, and other content whose main goal is expressive rather than informative.

To ensure this guideline works well across different languages,
members of AG, COGA, and internationalization (i18n) agreed on an initial set of languages to pressure-test the guidance.
The five "guardrail" languages are:

- Arabic
- English
- Hindi
- Mandarin
- Russian

We started with the six official languages of the United Nations (UN). Then we removed French and Spanish because they are similar to English. We added Hindi because it is the most commonly spoken language that is not on the UN list.

The group of five languages includes a wide variety of language features, such as:

- Right-to-left text layout
- Vertical text layout
- Tonal sounds that affect meaning

This list doesn't include every language, but it helps keep the work manageable while making the guidance more useful for a wide audience.
We will work with W3C’s Global Inclusion community group, the Internationalization (i18n) task force, and others to review and refine the testing and techniques for these requirements.
We also plan to create guidance for translating the guidelines into more languages in the future.
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: foundational
---

Explanations are available for the first use of abbreviations, acronyms, initialisms, and numeronyms.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: foundational
---

Content has a meaningful and understandable structure that clearly indicates the purpose of each section.
10 changes: 10 additions & 0 deletions guidelines/groups/text-and-wording/clear-language/common-words.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
status: developing
type: foundational
---

Common words are used, and definitions are available for uncommon words that the target audience is unlikely to know.

:::ednote
This requirement will include tests and techniques for content that is intended for specialized audiences rather than the general public.
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
status: developing
title: Non-literal language
type: foundational
---

Explanations or unambiguous alternatives are available for :term[non-literal language], such as idioms and metaphors.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: foundational
---

Alternatives are provided for numbers and numerical concepts.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
status: developing
type: assertion
---

- The organization has a documented process to review content for clear language before publication.
- If the organization uses AI tools to generate or alter content, the organization has a documented process for a human to review and attest that the content is clear and conveys the intended meaning.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: foundational
---

Sentences are streamlined to avoid unnecessary words or phrases and complex structures such as clauses within clauses that can make it hard for users to focus on the main point.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: foundational
---

Content is organized into short paragraphs or “chunks” to help users understand and remember the information.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
status: developing
type: assertion
---

- The organization has a documented style guide that includes guidance on clear language and a policy that requires editors to follow the style guide.
- The style guide includes guidance on clear words as well as clear numbers, such as avoiding or explaining Roman numerals, removing numerical information that is not essential for understanding the content, and providing explanations of essential numerical information to aid users with disabilities that impact cognitive accessibility.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: foundational
---

A summary is available for documents and articles that have more than 300 words.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: supplemental
---

For content intended to inform the user, each paragraph begins with a sentence stating the aim or purpose.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: assertion
---

- The organization has documented training material for content editors that includes guidance on clear language and a policy that editors are required to complete the training regularly.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: foundational
---

Numerical information includes sufficient context to avoid confusion when presenting dates, temperatures, time, and Roman numerals.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
status: developing
type: supplemental
---

For Arabic and Hebrew, where letters or diacritics needed for phonetic reading are often omitted,
an alternative version is provided with these missing elements included.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
needsAdditionalResearch: true
status: exploratory
status: developing
type: foundational
---

The verb tense used is easiest to understand in context.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
status: developing
type: foundational
---

Visual aids are available to supplement and aid understanding of complex ideas in written content, such as processes, workflows, relationships, or chronological information.
25 changes: 0 additions & 25 deletions guidelines/groups/text-and-wording/clear-meaning.md

This file was deleted.

This file was deleted.

This file was deleted.

11 changes: 0 additions & 11 deletions guidelines/groups/text-and-wording/simplified-written-content.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

29 changes: 29 additions & 0 deletions guidelines/terms/non-literal-language.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
status: developing
title: Non-literal language
---

words or phrases used in a way that are beyond their standard or dictionary meaning to express deeper, more complex ideas

:::note
This is also called figurative language.

To understand the content, users have to interpret the implied meaning behind the words, rather than just their literal or direct meaning.

Examples include:

- allusions
- hyperbole
- idioms
- irony
- jokes
- litotes
- metaphors
- metonymies
- onomatopoeias
- oxymorons
- personification
- puns
- sarcasm
- similes
:::
31 changes: 0 additions & 31 deletions guidelines/terms/non-literal-text.md

This file was deleted.