-
Notifications
You must be signed in to change notification settings - Fork 5
Expand plain language documentation with best practices #127
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,54 @@ | ||
| --- | ||
| title: Plain Language Federal Resources | ||
| description: Resources and training on Plain Language | ||
| permalink: /growing/plain-language/ | ||
| layout: layouts/page | ||
| section: growing | ||
| tags: ospo | ||
| eleventyNavigation: | ||
| parent: ospo-growing | ||
| key: ospo-growing-plainlanguage | ||
| order: 9 | ||
| title: Plain Language | ||
| sidenav: true | ||
| sticky_sidenav: true | ||
| --- | ||
|
|
||
| - [Plainlanguage.gov](https://www.plainlanguage.gov/guidelines/) | ||
| - [Federal Plain Language Guidance](https://digital.gov/resources/federal-plain-language-guidelines/) | ||
| ## What is Plain Language? | ||
|
|
||
| Plain language is communication that people can understand the first time they read or hear it. It helps readers quickly find information, understand what it means, and take appropriate action. | ||
|
|
||
| ## Why Plain Language Matters | ||
| Using plain language helps organizations: | ||
|
|
||
| * Improve accessibility | ||
| * Reduce misunderstandings | ||
| * Increase trust and transparency | ||
| * Make information easier to find and use | ||
| * Improve user experience across digital services | ||
|
|
||
| For government organizations, plain language supports effective communication with the public and helps ensure information is accessible to everyone. | ||
| ## Plain Language Best Practices | ||
|
|
||
| ### Know Your Audience | ||
| Understand who will use the information and what they need to accomplish. Write with their goals and level of expertise in mind. | ||
|
|
||
| ### Use Common Words | ||
| Avoid jargon, unnecessary acronyms, and technical terminology whenever possible. If specialized terms are required, explain them clearly. | ||
|
|
||
| ### Keep Sentences and Paragraphs Short | ||
| Shorter sentences and paragraphs are easier to read and understand, especially on digital platforms. | ||
|
|
||
| ### Use Active Voice | ||
| Active voice is generally clearer and more direct. | ||
|
|
||
| Instead of: | ||
| "The application must be submitted by the user." | ||
|
|
||
| Use: | ||
| "The user must submit the application." | ||
|
|
||
| ### Organize Information Clearly | ||
| Use headings, bullet lists, descriptive titles, and logical structure to help readers navigate content quickly. | ||
|
|
||
| ### Make Content Easy to Scan | ||
| Most users scan webpages before reading them in detail. Highlight important information using: | ||
| * Headings | ||
| * Bulleted lists | ||
| * Short paragraphs | ||
| * Meaningful links | ||
|
|
||
| ### Focus on Action | ||
| Clearly explain what readers need to do and what will happen next. | ||
|
|
||
| ## Federal Resources | ||
| * PlainLanguage.gov | ||
| * Federal Plain Language Guidelines | ||
| * Digital.gov Plain Language Web Writing Tips | ||
|
Comment on lines
+48
to
+51
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Currently, these websites are plain text. Could you add them as links to these resources so it would be helpful for users to check out |
||
|
|
||
| ## Additional Reading | ||
| Digital.gov provides practical guidance for creating web content that is concise, accessible, and user-centered. Their recommendations emphasize audience-focused writing, scannable content, and clear calls to action. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please make "digital.gov" a link to the digital.gov plain language guide |
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lines 1-15 are deleted but this is front matter needed for the website so it displays successfully at https://dsacms.github.io/ospo-guide/growing/plain-language/. Please return this!