Skip to content

Commit

Permalink
Merge pull request #13 from cagov/content-qa-fixes
Browse files Browse the repository at this point in the history
Content qa fixes
  • Loading branch information
m-sullivan7 authored Dec 20, 2023
2 parents 161382b + b0588d3 commit f279ccf
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 22 deletions.
18 changes: 11 additions & 7 deletions docs/pages/content-design/odi-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Browsers show a page title when you hover over the page tab. It helps people kno
Make the title the same as the H1 of the page, followed by a pipe and the site name. This gives people a full understanding of the page.

> Example:
> Content style guide | California Design System
> ODI's style guide | Innovation Hub
### Webpage URLs

Expand Down Expand Up @@ -204,19 +204,19 @@ Use more than one decimal place when using this rule or rounding would cause you
> Example:
> .04 deaths per 100K
### Fractions
Do not use 0.0.

Write fractions using a slash. This is more accurate than using decimal places. It’s also easier for people to understand.
Use 2 decimal places if you’re writing a price that isn’t a round number.

> Example:
> About 2/3 of California’s cities and counties do not allow cannabis retail activity.
> The cost of a new license is $29.99.
Do not use 0.0.
### Fractions

Use 2 decimal places if you’re writing a price that isn’t a round number.
Write fractions using a slash. This is more accurate than using decimal places. It’s also easier for people to understand.

> Example:
> The cost of a new license is $29.99.
> About 2/3 of California’s cities and counties do not allow cannabis retail activity.
### Numerals

Expand Down Expand Up @@ -470,6 +470,10 @@ ODI calls its base organizational unit a **team**. Teams make up divisions.
> The talent team recruits great people to work at ODI.
> The user research team piloted Ethnio intercepts on state webpages.
### that is

Use **that is** instead of **i.e.**, which is an abbreviation of the Latin phrase *id est*. This translates to “that is.” Writing out “that is” makes it clear to the reader what you mean.

### Tribe

When referencing a specific Native American community, capitalize **Tribe** or **Tribal** as a sign of respect. This follows federal [Bureau of Indian Affairs language guidelines](https://www.bia.gov/guide/editorial-guide#cultural-terms). In other contexts, do not capitalize.
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/content-design/plain-language-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ Adapted from the US Department of Labor’s [Use plain language for claimant not

| **Category** | **Rating** | **Tips** |
| ----- | ----- | ----- |
| [Written for easy reading by the average reader](https://www.plainlanguage.gov/guidelines/audience/) | Grade 0-14 reading level, plus Postgraduate | Measure reading level to make sure it’s not too high for your audience. Check this through [Hemingway](https://hemingwayapp.com/). Target is 6th-8th Grade level. |
| [Written for easy reading by the average reader](https://www.plainlanguage.gov/guidelines/audience/) | Grade 0-14 reading level, plus Postgraduate | Measure reading level to make sure it’s not too high for your audience. Check this through [Hemingway](https://hemingwayapp.com/). Target is grade 8 or lower. |
| [Organized to serve the reader’s needs](https://www.plainlanguage.gov/guidelines/organize/) | Yes, No, N/A | Content should be organized around what the reader wants to know and their potential next steps. |
| [Has useful headings](https://www.plainlanguage.gov/guidelines/organize/add-useful-headings/) | Yes, No, N/A | Content should be organized around what the reader wants to know and their potential next steps. |
| [Has useful headings](https://www.plainlanguage.gov/guidelines/organize/add-useful-headings/) | Yes, No, N/A | Headings act as landmarks that help people understand what they are about to read, so make these as clear as possible. For example, including “Unemployment insurance benefits” in your heading makes it clear to claimants which benefits they are about to read about, which can be helpful if individuals have applied for multiple benefits. |
| [Uses sentence case](https://readabilityguidelines.co.uk/grammar-points/capital-letters/), even in titles and headings | Yes, No, N/A | Capitalize only proper nouns and the first word in sentences. This makes text easier to read and understand. |
| [Uses “you” and other pronouns to speak to readers](https://www.plainlanguage.gov/guidelines/audience/address-the-user/) | Yes, No, N/A | Addressing the reader directly and using a human-centered tone helps readers understand what is relevant to them. |
| Uses [short sections](https://www.plainlanguage.gov/guidelines/concise/write-short-sections/) and [short sentences](https://www.plainlanguage.gov/guidelines/concise/write-short-sentences/) | Yes, No, N/A | Overly complex sentences can be hard to parse. Review long sentences for core points and break them up into shorter sentences, grouping them by theme or timeline of events to increase clarity. |
| [Uses the simplest tense possible](https://www.plainlanguage.gov/guidelines/conversational/use-the-present-tense/) | Yes, No, N/A | Speak in the present tense. Simple present is best. |
| [Uses active voice, not hidden verbs](https://www.plainlanguage.gov/guidelines/words/avoid-hidden-verbs/) | Yes, No, N/A | Use the strongest, most direct form of the verb possible. For example: “We scheduled a fact-finding interview” vs. “There was a fact-finding interview scheduled.” |
| [Omits excessive words](https://www.plainlanguage.gov/guidelines/concise/write-short-sentences/) | Yes, No, N/A | Have one main idea per sentence. |
| [Uses common, familiar words](https://www.plainlanguage.gov/guidelines/words/use-simple-words-phrases/) | Yes, No, N/A | Avoid legalese, jargon, and figurative language. |
| [Places words carefully](https://www.plainlanguage.gov/guidelines/words/place-words-carefully/) | Yes, No, N/A | Avoid large gaps between the subject, the verb, and the object. Put exceptions last. Place modifiers correctly. |
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/content-design/principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ We were inspired by the work of teams that came before us, including:
* [Government Digital Service](https://www.gov.uk/government/organisations/government-digital-service) in the United Kingdom
* The [Plain Language Action and Information Network](https://www.plainlanguage.gov/) at the US federal government
* [Public Digital](https://public.digital/)
* [San Francisco Digital Services](https://digitalservices.sfgov.org/)
* [San Francisco Digital Services](https://www.sf.gov/departments/city-administrator/digital-services))
* [U.S. Digital Service](https://www.usds.gov/)
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Accessibility goes beyond the technical components of a website. It’s about in

## Standards

State law requires that state websites be accessible. Content writers are responsible for maintaining some of these standards. An accessibility audit service (like [SiteImprove](https://siteimprove.com/)) will check your website against accessibility standards and identify where you can take action.
State law requires that state websites be accessible. Content writers are responsible for maintaining some of these standards. An accessibility audit service (like [SiteImprove](https://www.siteimprove.com/)) will check your website against accessibility standards and identify where you can take action.

## Why this is important

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ Encourage your stakeholders to focus their content on requirements instead of re
* Use **must** when telling people what they need to do.
* Use **should** as little as possible and only for recommendations.
* When stakeholders want to use **should**, ask them if people have to do something or if it’s a suggestion.
* Learn more about how to write about requirements at [plainlanguage.gov](https://www.plainlanguage.gov/guidelines/conversational/use-must-to-indicate-requirements/).
* Learn more about [how to write about requirements at plainlanguage.gov](https://www.plainlanguage.gov/guidelines/conversational/use-must-to-indicate-requirements/).
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,3 @@ Check reading levels with the [Hemingway Editor](http://hemingwayapp.com/). Elim
* Use commas in numbers over 999. This helps people understand the order of magnitude.
* Use the serial comma (also called the Oxford comma) to reduce confusion. It’s the comma that comes before **and** in a list of 3 or more.
* For example: _We brought apples, bananas, and oranges_.

The Office of Data and Innovation has more [plain language resources](https://docs.data.ca.gov/calinnovate-toolkit/NQUp2SeHnvd3YF16tw4N/readme/plain-language-resources) in their service delivery toolkit.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ A conversational tone and an official one can seem like they’re opposites of e
* For example: _If you need benefits, apply by May 23, 2021_. Do not say _The benefits application deadline is May 23, 2021_.
* Do not use **me** or **my**. It’s unclear if it refers to the reader or the writer.
* Use transition words where it makes sense. Start sentences with **And** or **But** to show the relationship between pieces of information.
* Example (courtesy of [Plainlanguage.gov](https://www.plainlanguage.gov/guidelines/organize/use-transition-words/)): _A topic sentence may provide a transition from one paragraph to another. But a transition word or phrase (usually in the topic sentence) clearly tells the audience whether the paragraph expands on the paragraph before, contrasts with it, or takes a completely different direction._
* Example (courtesy of [Plainlanguage.gov's Use transition words](https://www.plainlanguage.gov/guidelines/organize/use-transition-words/)): _A topic sentence may provide a transition from one paragraph to another. But a transition word or phrase (usually in the topic sentence) clearly tells the audience whether the paragraph expands on the paragraph before, contrasts with it, or takes a completely different direction._
* Vary the lengths of your sentences and paragraphs. This makes your writing sound natural.
* Avoid jargon or unfamiliar terms. If you must use them, do so sparingly, and define them for the reader.

Expand Down
8 changes: 4 additions & 4 deletions docs/pages/content-design/recommended-reading.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Articles, guides, and tools to learn more about content design

* [ODI's content design principles](/content-design/principles/)
* [California Design System principles](https://designsystem.webstandards.ca.gov/principles/)
* [Government Code 6219](https://designsystem.webstandards.ca.gov/principles/), California’s plain language statute
* [Government Code 6219](https://leginfo.legislature.ca.gov/faces/codes_displaySection.xhtml?sectionNum=6219.&lawCode=GOV), California’s plain language statute
* [US Web Design System principles](https://designsystem.digital.gov/design-principles/)

## Online courses
Expand All @@ -19,10 +19,10 @@ description: Articles, guides, and tools to learn more about content design
## Style guides

* [Associated Press (AP) Style](https://store.stylebooks.com/): ODI’s default for style questions not covered by [our style guide](/content-design/odi-style-guide/)
* [18F content guide](https://content-guide.18f.gov/) at the federal government
* [18F content guide](https://guides.18f.gov/content-guide/) at the federal government
* [How to write for SF.gov](https://sfdigitalservices.gitbook.io/style-guide/city-standards)
* [Federal plain language guidelines](https://www.plainlanguage.gov/guidelines/) at plainlanguage.gov
* Federal [style guides by government agencies](https://digital.gov/resources/style-guides-by-government-agencies/?dg)
* Federal [style guides by government agencies](https://digital.gov/resources/style-guides-by-government-agencies/)
* [GOV.UK A to Z of style – words to avoid](https://www.gov.uk/guidance/style-guide/a-to-z-of-gov-uk-style#words-to-avoid): a list of some words that make your content less clear, created by a UK government content team

## How-to's
Expand Down Expand Up @@ -70,7 +70,7 @@ description: Articles, guides, and tools to learn more about content design
* [Hemingway Editor](http://hemingwayapp.com/)
* [ODI’s plain language checklist](/content-design/plain-language-checklist/): detailed guidance on how to improve your writing

##
## Books

* [Content Design](https://contentdesign.london/shop/content-design-by-sarah-winters-paperback) - Sarah Winters
* [Writing for dollars, writing to please: The case for plain language in business, government, and law](https://a.co/d/3bHM6Md) - Joseph Kimble
4 changes: 2 additions & 2 deletions docs/pages/how-to-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Our training gives you access to best practices in innovation. They’re a great

## Recommended reading

ODI is always researching how to deliver great services. We save our favorite articles and tools to use them in our work. Our recommended reading is a good way to dive into a topic and expand your knowledge.
ODI is always researching how to deliver great services. We save our favorite articles and tools to reference them in our work. Our recommended reading is a good way to dive into a topic and expand your knowledge.

## Templates

We often make templates to streamline our work. Take our templates and use them as-is, or change them to fit your department, to make your work easier.
We often make templates to streamline our work. Take our templates and use them to make your work easier. Feel free to change them to fit your department.

We’ve organized resources by topic. The topics on the Hub are:

Expand Down
2 changes: 1 addition & 1 deletion docs/site/homepage.njk
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: This system makes it easy to build digital services that meet the n
<p>If you want a place to start, we have recommendations for how to use each type of resource.
</p>
<div class="wp-block-button">
<a class="btn-primary" href="/get-started/">Learn how to use the Hub</a>
<a class="btn-primary" href="/how-to-use/">Learn how to use the Hub</a>
</div>
</div>
</div>
Expand Down

0 comments on commit f279ccf

Please sign in to comment.