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

Update best practices for bolding content for "key:value" #346

Open
2 of 6 tasks
CrystabelReiter opened this issue Nov 24, 2020 · 4 comments
Open
2 of 6 tasks

Update best practices for bolding content for "key:value" #346

CrystabelReiter opened this issue Nov 24, 2020 · 4 comments

Comments

@CrystabelReiter
Copy link
Contributor

Feature Request

  • I’ve searched for any related issues and avoided creating a duplicate issue.

This update is for:

  • Content styleguide
  • Component
  • Pattern
  • Utility
  • Other

What is the name

https://design.va.gov/content-style-guide/bold-text

What is the nature of this update?

There are inconsistencies across the platform around what is bolded: the key or the value
Example:
Current rating: 10%
or
Last opened: January 16, 2020

Peggy informed us that we generally bold punctuation with shorter labels (ie. Date:, Note:), but don't bold with longer headers.

(invite a content specialist to this design system council discussion -- Randi will be responsible in updating the content style guide)

Additional Context

image

image

image

image

@CrystabelReiter
Copy link
Contributor Author

Final decision from Design System council meeting on 12/4/20:
We recommend bolded key and not bolded value stacked vertically without a colon.
@RLHecht Please update content documentation on design.va.gov. Thank you!

@RLHecht
Copy link

RLHecht commented Jan 6, 2021

@CrystabelReiter I'm trying to add an example of the correct styling in the entry I'm writing for the style guide so I can link to it. So far, I can only find it the wrong way on the few unauthenticated pages I've looked at so far. For example: https://www.va.gov/disability/file-disability-claim-form-21-526ez/introduction Do you have a suggestion of where I can find a correct one where the user wouldn't need to log in to see it?

@humancompanion-usds
Copy link
Collaborator

@megzehn and @laurwill - I found this deep in our backlog but, it remains, to my knowledge, unsolved. Can you have a look and perhaps queue this up for an update to the Content Style Guide? Thanks!

@megzehn
Copy link
Collaborator

megzehn commented Aug 14, 2024

Thanks for sharing this, @humancompanion-usds!

It looks like we did add something to the bold section of the style guide (in the last bullet list). I'll paste it here for reference.

If you’re presenting a series of label and value pairs, such as the contact information (address, phone number, etc.) for a location. The label is always bold, not the value, and the label and value are separated by a line break as opposed to a colon. Review examples on the H. John Heinz III Department of VA Medical Center page

I'm thinking we probably want to clarify the part about when to use a colon vs line break. I'll look for other examples and bring this up with Danielle and Beth. But in the meantime, I think it's OK to close this ticket from my perspective.

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

No branches or pull requests

6 participants