Skip to content

Expand plain language documentation with best practices - #127

Open
huda-code wants to merge 3 commits into
DSACMS:mainfrom
huda-code:patch-1
Open

huda-code wants to merge 3 commits into
DSACMS:mainfrom
huda-code:patch-1

Conversation

@huda-code

@huda-code huda-code commented Jun 8, 2026

Copy link
Copy Markdown

Added sections on the importance of plain language, best practices, and federal resources to enhance understanding and usability.

module-name: Expand plain language guidance and federal resources

Problem

The existing Plain Language page contained limited information and did not explain what plain language is, why it matters, or how contributors can apply it. Additional practical guidance and links to authoritative federal resources were needed. This pull request addresses #32.

Solution

Expanded content/growing/plain-language.md to include:

A definition of plain language
An explanation of why plain language matters
Best practices for understanding the audience, using common words, writing shorter sentences, using active voice, and organizing information clearly
Guidance for making web content scannable and action-oriented
Links to federal plain language resources and Digital.gov
Updated page metadata and properly formatted resource links

Result

The Plain Language page now provides contributors with practical, actionable guidance for writing clear, accessible, and user-centered documentation. Readers can also access federal resources for further training and guidance.

Test Plan

Reviewed the Markdown headings, paragraphs, lists, and links for correct formatting
Confirmed that the required page front matter is present
Verified that the content follows a clear and logical structure
Checked that the Digital.gov resource links point to the intended plain language guidance
Reviewed the page content for clarity, readability, and consistency

AI Usage

  • [ -] Generated AI was used in this contribution

If checked, please provide an explanation on how AI was used in the development of this pull request:

  • Description: Include a high level description of Gen AI utilization
  • Type of assistance:
    • Code generation
    • [- ] Documentation
    • Debugging
    • Testing
    • Refactoring
    • Other:
  • Scope of usage: Which files, functions, or sections were AI-assisted
  • AI System used:
    • [- ] ChatGPT
    • Claude
    • Gemini
    • GitHub Copilot
  • Level of modification:
    • As-is
    • [ -] Modified
    • Used as inspiration
  • Prompts used: Please list or explain prompts that were used to develop this contribution

Added sections on the importance of plain language, best practices, and federal resources to enhance understanding and usability.

@natalialuzuriaga natalialuzuriaga left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. For documentation, please fill out the PR template with information about the Problem, Solution, and Result. Note that this PR address this issue: #32
  2. I flagged changes in markdown file to be addressed

Thank you!

Comment thread content/growing/plain-language.md Outdated
Comment thread content/growing/plain-language.md Outdated
Comment thread content/growing/plain-language.md
@natalialuzuriaga natalialuzuriaga added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 17, 2026
Added metadata and updated resources for Plain Language.
@huda-code

Copy link
Copy Markdown
Author

Hi @natalialuzuriaga, thank you for the helpful review. I restored the required front matter, updated the federal resources into Markdown links, linked Digital.gov in the Additional Reading section, and filled out the PR template with the Problem, Solution, Result, and Test Plan.

@natalialuzuriaga natalialuzuriaga left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another round of changes please!

I do not see the PR template filled out with the Problem, Solution, Result, and Test Plan. Again, please fill out this information as this is part of our development guidelines and workflow in order to get your contribution merged.

Finally, we just released our Gen AI Policy where it is required to disclose AI usage if you used this in this contribution. I updated the PR template with the new section so please fill this out as well!

Comment thread content/growing/plain-language.md Outdated
Comment thread content/growing/plain-language.md Outdated
Comment thread content/growing/plain-language.md Outdated
Comment thread content/growing/plain-language.md
Added metadata for the Plain Language page and updated resource links.
@huda-code

Copy link
Copy Markdown
Author

Hi @natalialuzuriaga, I’ve addressed the requested changes, updated the PR description and AI disclosure, and pushed the corrected file. The automated checks are now running. When you have a chance, could you please review the updated PR?

@natalialuzuriaga

Copy link
Copy Markdown
Contributor

Hi @huda-code,

The requested changes LGTM. Thank you for the revisions!. Last thing: as this is part of our development guidelines and workflow in order to get your contribution merged, please fill out the PR template and new AI disclosure -- it is blank

@natalialuzuriaga

Copy link
Copy Markdown
Contributor

Hi @huda-code, following up on this loop! Last thing before we can merge this PR: as part of our development guidelines and workflow in order to get your contribution merged, please fill out the PR template and new AI disclosure -- it is blank.

@huda-code

Copy link
Copy Markdown
Author

Hi @natalialuzuriaga, apologies for the delayed response, I missed the earlier notification. Thank you for following up. I have now edited the main PR description and completed the Problem, Solution, Result, Test Plan, and AI Usage sections. The disclosure reflects how ChatGPT assisted with the documentation. It should now be ready for final review.

@natalialuzuriaga

Copy link
Copy Markdown
Contributor

Hi @huda-code, thank you for filling out the missing sections. For the AI Usage section, I see that the description, scope of usage, and prompts used questions are empty. Please answer these questions so we can get a complete picture of how AI was used in your PR. Again, this is part of our development workflow and guidelines where contributors must follow in order to get their contributions merged.

@natalialuzuriaga

Copy link
Copy Markdown
Contributor

Hi @huda-code, following up on the comment above! Let me know if you have any questions

@natalialuzuriaga

Copy link
Copy Markdown
Contributor

@huda-code, following up!

@natalialuzuriaga

Copy link
Copy Markdown
Contributor

@huda-code, following up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants