Skip to content

USWDS-Site: Updating links per Design Principles audit#3053

Merged
annepetersen merged 16 commits intomainfrom
kf-designprinciples-updt
Feb 21, 2025
Merged

USWDS-Site: Updating links per Design Principles audit#3053
annepetersen merged 16 commits intomainfrom
kf-designprinciples-updt

Conversation

@finekatie
Copy link
Copy Markdown
Contributor

@finekatie finekatie commented Jan 9, 2025

Summary

After extensive audit of links to determine relevance of links, edits can be made to this page.

Important

This page does not have a changelog - one needs to be added

Related issue

Closes #3054 / #2573

Preview link

Design principles page

Problem statement

Resources linked throughout the Design Principles page were aging or no longer relevant.

Solution

UX, CS, A11y teams and feds to audit and analyze relevance and timeliness of links, update and add new as needed.

Related documents:
Audit
Page draft with edits

Testing and review

Need reviews to compare to the page draft make sure links work and content is clean and clear.

After extensive audit of links to determine relevance of links, edits can be made to this page.
@finekatie finekatie requested a review from a team as a code owner January 9, 2025 22:38
@finekatie finekatie self-assigned this Jan 9, 2025
@finekatie finekatie added the Role: Content Content/writing skills needed label Jan 9, 2025
@finekatie finekatie changed the title Updating links per Design Principles audit USWDS-Site - Guidance: Update links on Design Principles page Jan 10, 2025
@finekatie finekatie changed the title USWDS-Site - Guidance: Update links on Design Principles page Updating links per Design Principles audit Jan 10, 2025
@finekatie finekatie changed the title Updating links per Design Principles audit USWDS-Site: Updating links per Design Principles audit Jan 10, 2025
Copy link
Copy Markdown
Contributor

@jaclinec jaclinec left a comment

Choose a reason for hiding this comment

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

Finished my review and added my comments to the page draft since it's probably clearer there. There was one link in the draft that I didn't see in the preview (18F User Experience Guide — Research ), and I commented on 3 other links - one that I think we decided should be removed, one that was duplicative, and one where I wondered if there was a more up-to-date resource to link to.

Made a few corrections per comments from JC in the draft doc.
@finekatie
Copy link
Copy Markdown
Contributor Author

@jaclinec - I made updates per your comments in the draft. Please review when you are up to it.

@jaclinec
Copy link
Copy Markdown
Contributor

@finekatie everything looks good now - thanks!

@finekatie
Copy link
Copy Markdown
Contributor Author

I reviewed links to make sure nothing was broken due to recent policy changes. All looks good. @annepetersen and @thisisdano this is ready for FFR.

@finekatie finekatie requested a review from jaclinec January 21, 2025 22:05
@finekatie
Copy link
Copy Markdown
Contributor Author

@finekatie everything looks good now - thanks!
When you can - can you re-review? Thanks! @jaclinec !

Copy link
Copy Markdown
Contributor

@amycole501 amycole501 left a comment

Choose a reason for hiding this comment

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

I read over and clicked all the links focusing on the a11y section. The only slight oddity is that when I click the plain language link I see a bunch of weird code (maybe tracking code?) in the URL

1.Try clicking the "learn about writing in plain language" link under "further reading" in the "embrace accessibility" section.

  1. Then look at your browser bar to see the URL or see below:

https://www.plainlanguage.gov/?_gl=1*t39m7h*_ga*MTI1NTE2MTY5Ni4xNzM0NTQ2MDY0*_ga_HBYXWFP794*MTczNzY0NDA4Mi41LjEuMTczNzY0NjA4MS4wLjAuMA..

It didn't seem to do that on the other plain language link on the page. I also deleted that code and the URL works fine. So maybe just a weird glitch (?)

Copy link
Copy Markdown
Contributor

@jaclinec jaclinec left a comment

Choose a reason for hiding this comment

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

@finekatie
Copy link
Copy Markdown
Contributor Author

Note: More 404 errors occurring. Links being audited again and corrections will be made. Will resubmit this for review once updates made to the branch.

Comment thread pages/design-principles/overview.md Outdated
- [Delivering Excellent, Equitable, and Secure Federal Services and Customer Experience](https://bidenadministration.archives.performance.gov/pma/cx/) [performance.gov]
- [Tips for Starting Your Customer Experience Journey](https://www.performance.gov/cx/blog/tips-for-starting-your-customer-experience-journey/) [performance.gov]
- [OMB Circular A-11 Section 280: Managing Customer Experience and Improving Service Delivery](https://www.performance.gov/cx/assets/files/a11_2021-FY22.pdf) [performance.gov]
- [OMB Circular A-11 Section 280: Managing Customer Experience and Improving Service Delivery](https://www.whitehouse.gov/wp-content/uploads/2018/06/s280.pdf)(PDF) [performance.gov]
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.

@finekatie
issue: Looks like this link is 404-ing now

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hey @jaclinec , should we go back to the old one or remove entirely? https://www.performance.gov/cx/assets/files/a11_2021-FY22.pdf

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Discussed with Jacline. Removing version.

Copy link
Copy Markdown
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

Looking good, just found a couple of possible small copy tweaks in the comments below.

  • Confirm the code meets standards
  • Confirm the branch is up to date and tests pass
  • Confirm no regressions in content display
  • Confirm copy updates match pre-existing conventions
  • Confirm the changelog is present and accurate

Note that I did not compare the changes to the edit doc (let me know if you want me to do that)

Comment thread pages/design-principles/overview.md Outdated
Comment thread pages/design-principles/overview.md Outdated
finekatie and others added 2 commits January 31, 2025 11:01
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
amyleadem
amyleadem previously approved these changes Jan 31, 2025
Copy link
Copy Markdown
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

LGTM from a engineering perspective!

jaclinec
jaclinec previously approved these changes Feb 3, 2025
Copy link
Copy Markdown
Contributor

@jaclinec jaclinec left a comment

Choose a reason for hiding this comment

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

Everything looks good to me! :)

@finekatie
Copy link
Copy Markdown
Contributor Author

Hi @amycole501 , do you want to complete your review?

@amycole501
Copy link
Copy Markdown
Contributor

Reviewed last month approved.

updating changelog
@annepetersen annepetersen dismissed stale reviews from jaclinec and amyleadem via 0ac46ce February 19, 2025 22:03
annepetersen
annepetersen previously approved these changes Feb 19, 2025
Copy link
Copy Markdown
Contributor

@annepetersen annepetersen left a comment

Choose a reason for hiding this comment

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

LGTM

@annepetersen
Copy link
Copy Markdown
Contributor

The HTML Proofer is preventing merge on this because of the broken links that were fixed in #3092. Could I get a dev to update the branch? Tagging @amyleadem since you'd been handling this one to this point

@annepetersen annepetersen assigned amyleadem and unassigned finekatie Feb 19, 2025
@amyleadem
Copy link
Copy Markdown
Contributor

The build errors here should be fixed by #3121

@amyleadem
Copy link
Copy Markdown
Contributor

@annepetersen Tests are passing again. This is ready for your review.

@annepetersen annepetersen merged commit 63789c4 into main Feb 21, 2025
@annepetersen annepetersen deleted the kf-designprinciples-updt branch February 21, 2025 20:49
@annepetersen annepetersen moved this from Fed Final Review to Done in USWDS Core Project Data Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Role: Content Content/writing skills needed

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Update Design principles page

5 participants