department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
281 stars 197 forks source link

Guidance: Title Tags #84040

Open kristinoletmuskat opened 3 months ago

kristinoletmuskat commented 3 months ago

IA standards request

Define clear standards and guidance that teams must meet related to Title Tags

Goal: Document clear guidance and standards for Title Tags that teams need to meet, and identify where we need to edit/add info on the design system.

Existing Documentation:

Acceptance criteria

kristinoletmuskat commented 3 months ago

@mnorthuis and @erinrwhite I believe we reviewed this with Mikki back in January, but if we want to put it through our new process (or maybe if you can publish Erin instead of waiting on Matt), here is the draft: https://docs.google.com/document/d/1EA9iEw1mCE8P7-JxEwX5r7yFnz1xxyG-dCviPoh_oSA/edit

mnorthuis commented 3 months ago

Looks like for this one we just need to get the forms and subtasks info added as a second exception. This info should likely either be repeated or there should be a link to this page from both the subtask pattern and the templates - form page.

I did not do a comparison of what's in the title tags section of the content style guide SEO/title tagsvs what is in this google doc though...

Also agree that the meta data info may either need to be pulled out of the content style guide, or it may need to be titled as meta data vs writing for SEO.

kristinoletmuskat commented 3 months ago

Thanks for taking a look! Yes what I've tried to do is copy/paste sections directly from the design system and style guide, and then show the exact edits and additions we're looking to make.

So for this first iteration, we're proposing that we create a new section of the style guide called "Title tags", given how frequently our design system users look for it and can't find it under 'writing for SEO'. So what will remain in 'writing for SEO' is 'SEO best practices for writing copy' and 'Meta properties'. And we would link to the new title tag section from the Writing for SEO page. Does this make sense?

Screenshot 2024-05-29 at 3 59 47 PM Screenshot 2024-05-29 at 3 59 53 PM

kristinoletmuskat commented 2 months ago

Matt published our initial guidance from January here: https://design.va.gov/content-style-guide/title-tags

erinrwhite commented 2 months ago

@kristinoletmuskat I put in a pull request to update the guidance - I spotted a formatting error that was making the examples for the form titles give incorrect guidance.

kristinoletmuskat commented 2 months ago

ooo @erinrwhite thank you so much! Matt mentioned that he struggled with the formatting of the word doc. I wonder if there's a way to make it more clear? Or if now that you will be publishing, perhaps it wont be as big of an issue.

erinrwhite commented 1 month ago

PR merged, okay to close this one.

erinrwhite commented 1 month ago

Sigh...reopening. We need to announce this new and improved Title tag guidance to VFS teams! @mnorthuis tossing to you for next steps.