Expand plain language documentation with best practices#127
Conversation
Added sections on the importance of plain language, best practices, and federal resources to enhance understanding and usability.
There was a problem hiding this comment.
Hi @huda-code,
Thank you so much for this valuable contribution to our ospo-guide. We've been meaning to update our plain language guide so this work is so appreciated.
A couple of things before we ship this guide:
- For documentation, please fill out the PR template with information about the
Problem,Solution, andResult. Note that this PR address this issue: #32 - I flagged changes in markdown file to be addressed
Thank you!
| ## Federal Resources | ||
| * PlainLanguage.gov | ||
| * Federal Plain Language Guidelines | ||
| * Digital.gov Plain Language Web Writing Tips |
There was a problem hiding this comment.
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
| * Digital.gov Plain Language Web Writing Tips | ||
|
|
||
| ## 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. |
There was a problem hiding this comment.
Please make "digital.gov" a link to the digital.gov plain language guide
| title: Plain Language | ||
| sidenav: true | ||
| sticky_sidenav: true | ||
| --- |
There was a problem hiding this comment.
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!
Added sections on the importance of plain language, best practices, and federal resources to enhance understanding and usability.
module-name: One line description of your change (less than 72 characters)
Problem
Explain the context and why you're making that change. What is the problem
you're trying to solve? In some cases there is not a problem and this can be
thought of being the motivation for your change.
Solution
Describe the modifications you've done.
Result
What will change as a result of your pull request? Note that sometimes this
section is unnecessary because it is self-explanatory based on the solution.
Some important notes regarding the summary line:
Test Plan
(Write your test plan here. If you changed any code, please provide us with
clear instructions on how you verified your changes work.)