uswds-site icon indicating copy to clipboard operation
uswds-site copied to clipboard

Voice/tone audit on component pages

Open thisisdano opened this issue 4 years ago • 0 comments

The more consistency we can bring to how we write and structure our guidance pages, the better teams and implementors can find and use the guidance we provide. Our component pages could use a voice and tone audit to give us a sense of how we're using words and phrases in our guidance. For instance:

  • Plural or singular in component names?
  • "Should", "must", "may", "can": How do we convey importance and necessity?
  • Do we try to construct positive ("prefer") or negative ("avoid") statements? Does it matter?
  • Do we have an institutional voice? Should we?
  • What guidance can we provide publicly or internally around how we write guidance?

Let's look at our component pages to start and provide recommendations around how we might write with better consistency, clarity, and tone.

  • Guidance page editorial style guide https://github.com/uswds/uswds-team/issues/58

thisisdano avatar Jun 15 '20 17:06 thisisdano