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 USWDS Style Guide #291

Open
6 tasks
sarah-sch opened this issue Oct 25, 2023 · 0 comments
Open
6 tasks

Update USWDS Style Guide #291

sarah-sch opened this issue Oct 25, 2023 · 0 comments
Assignees
Labels
Affects: Content Relates to content Affects: Guidance Relates to guidance Affects: Plain Language Relates to our effective use of plain language Affects: Usability Relates to the usability of our code or components Role: Content Content/writing skills needed

Comments

@sarah-sch
Copy link

sarah-sch commented Oct 25, 2023

Problem to be solved

USWDS don't have a comprehensive, up-to-date website content style guide.

Background

USWDS has multiple brief editorial style guides that haven't been regularly updated or socialized with the team. The dev team maintains two code style guides. All of these style guides are listed below.

Goals

Develop a source-of-truth editorial style guide including

  • brand voice and tone guidance
  • a definitive answer as to which established style guides the team should defer to for questions not answered by our own document (e.g., Digital.gov and then AP)
  • guidance surrounding grammar, punctuation, and other mechanics issues
  • a regularly updated word list
  • guidance surrounding how technical information such as code should be displayed on the USWDS website

###Work to be done

  • - Compare Digital.gov and 18F style guides to determine major differences and which one we wan to use as our "parent guide"
  • - Revisit and align on USWDS brand voice and tone guidance #345
  • - Take stock of existing style guidance and determine what to keep
  • - Build on existing guidance to create complete style guidance including work list, grammar and mechanics guidance, and guidance for talking about technical information such as code
  • - Socialize style guide with full team
  • - Where needed, update website to align with new guidance
@sarah-sch sarah-sch added Affects: Content Relates to content Affects: Guidance Relates to guidance Affects: Plain Language Relates to our effective use of plain language Affects: Usability Relates to the usability of our code or components Role: Content Content/writing skills needed labels Oct 25, 2023
@sarah-sch sarah-sch self-assigned this Oct 25, 2023
@brunerae brunerae changed the title Update USWDS Style Guides and Socialize with Team Update USWDS Style Guide Oct 23, 2024
@brunerae brunerae moved this to Ready to Schedule in USWDS Core Project Data Oct 23, 2024
@finekatie finekatie assigned finekatie and unassigned sarah-sch Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects: Content Relates to content Affects: Guidance Relates to guidance Affects: Plain Language Relates to our effective use of plain language Affects: Usability Relates to the usability of our code or components Role: Content Content/writing skills needed
Projects
Status: Ready to Schedule
Development

No branches or pull requests

2 participants