Skip to content
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

USWDS-Site - Icon: Update icon guidance #2643

Merged
merged 11 commits into from
Jun 7, 2024
Merged

USWDS-Site - Icon: Update icon guidance #2643

merged 11 commits into from
Jun 7, 2024

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Apr 29, 2024

Summary

Updated icon guidance according to the edits in USWDS Icon page guidance: Suggested changes (Google Docs 🔒)

Related issue

Closes #2612

Preview link

Icon component page

Testing and review

  1. Confirm that the copy matches USWDS Icon page guidance: Suggested changes (Google Docs 🔒)
  2. Confirm the copy makes sense and is accurate
  3. Confirm no regressions

- **Meaning is ambiguous.** Use icons only in a common or conventional way. Icon utility hinges on people quickly recognizing what each icon means. If you suspect that an icon’s intent isn’t perfectly clear, consider removing it or adding accompanying text.
- **Compensating for page structure.** Don’t rely on an icon to help draw attention to something important that’s otherwise hard to find. Icons don’t fix unclear page hierarchy or confusing content organization.
- **You need illustrative artwork.** Icons have a specific, functional meaning. Avoid using icons for illustrative purposes (like using the “visibility” eye icon ({{ visibility_icon }}) to illustrate an actual eye). If you want to enhance the appearance of your content or visually explain a concept, use an illustration instead of an icon.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jaclinec @sarah-sch @finekatie

I wasn't sure the best method for adding the icon example here. Right now it is in a parenthesis inside a parenthesis. Could we replace the outer parenthesis with a comma? Let me know what is best here!

image

Suggested change
- **You need illustrative artwork.** Icons have a specific, functional meaning. Avoid using icons for illustrative purposes (like using the “visibility” eye icon ({{ visibility_icon }}) to illustrate an actual eye). If you want to enhance the appearance of your content or visually explain a concept, use an illustration instead of an icon.
- **You need illustrative artwork.** Icons have a specific, functional meaning. Avoid using icons for illustrative purposes, like using the “visibility” eye icon ({{ visibility_icon }}) to illustrate an actual eye. If you want to enhance the appearance of your content or visually explain a concept, use an illustration instead of an icon.

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need the icon inside parentheses or could we just have it kind of floating out there? I don't want people to think the parentheses are part of the icon itself.

Copy link
Contributor

Choose a reason for hiding this comment

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

@amyleadem, @jaclinec - I would recommend removing the outer parentheses entirely and breaking it into two sentences: Avoid using icons for illustrative purposes. For example, don't use the "visibility eye icon (icon) to illustrate an actual eye.

Short, simple sentences are a plain language win, in addition to solving the parentheses issue.

Copy link
Contributor

Choose a reason for hiding this comment

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

@amyleadem @sarah-sch Sarah's suggestion works for me!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated this copy according to @sarah-sch's suggestion in a7d9334. Please let me know if you need any changes.

@amyleadem amyleadem marked this pull request as ready for review April 29, 2024 21:15
sarah-sch
sarah-sch approved these changes Apr 30, 2024
@sarah-sch sarah-sch self-requested a review April 30, 2024 16:07
Copy link
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.

Once the issue about the parentheses is resolved (I like Sarah's suggestion), this looks good to me - nice work!

@@ -2,6 +2,11 @@ title: Icon
type: component
changelogURL:
items:
- date: NNNN-NN-NN
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Important

We need to update the changelog date before merge

Copy link
Contributor

@mahoneycm mahoneycm left a comment

Choose a reason for hiding this comment

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

Matches the provided copy and looks good to me! 👍

Copy link
Contributor

@sarah-sch sarah-sch left a comment

Choose a reason for hiding this comment

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

@amyleadem - I reviewed and the page is looking good. I made one small suggestions. Thanks!

{:.usa-content-list }
- **Combine icons with text.** Only a few icons are consistently understood across the digital-using public of the world, among them home ({{ home_icon }}), print ({{ print_icon }}), and search ({{ search_icon }}). Combine icons with text to improve clarity, and test your icons for recognition and memorability with your particular audience.
- **Be consistent with icon meaning.** Icons used more than once in an application or site must be used to represent the same thing, and have the same text description in every instance. For example, if an icon of a blank piece of paper means “new document” on most screens, choose a different icon to communicate “reformat document.” Consistency helps people with some cognitive disabilities, people who might be distracted or scanning, and creates a better user experience for all.
Copy link
Contributor

Choose a reason for hiding this comment

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

I recommend adding the word "helps" to give this list a more parallel structure: Consistency helps people with some cognitive disabilities, helps people who might be distracted or scanning, and creates a better user experience for all.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good note. Updated in da7f69a. Let me know if you need anything else!

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good--thanks, @amyleadem!

@amyleadem amyleadem requested a review from thisisdano May 3, 2024 22:02
@thisisdano thisisdano merged commit 104caac into main Jun 7, 2024
11 checks passed
@thisisdano thisisdano deleted the al-icon-new-copy branch June 7, 2024 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

USWDS-Site - Icon page: Update icons guidance on site
5 participants