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.

Sign up for GitHub

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

⭐️ May maintenance release #71

Merged
merged 2 commits into from
May 29, 2024
Merged

⭐️ May maintenance release #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4195ba
Update odi-style-guide.md
m-sullivan7 May 1, 2024
ff6a9d0
Update recommended-reading.md
m-sullivan7 May 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 27 additions & 20 deletions docs/pages/content-design/odi-style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,32 @@ headericon: book

<p class="text-lead">These are the Office of Data and Innovation’s conventions and standard terms for writing. Our <a href="/content-design/principles/">content design principles</a> provide general guidance in how to write well.</p>

## Acronyms

Write out the full name of something the first time you mention it. Follow with the acronym in parentheses. Use the acronym for any other mentions.

<div class="blockquote-container">
<div class="blockquote-body">
<div class="blockquote-header"><strong>Example:</strong></div>
<div class="blockquote-content">
The Office of Data and Innovation (ODI) was founded in 2022. ODI partners with departments across the state.
</div>
</div>
</div>

Capitalize acronyms. Do not use periods between letters.

<div class="blockquote-container">
<div class="blockquote-body">
<div class="blockquote-header"><strong>Example:</strong></div>
<div class="blockquote-content">
CDC
</div>
</div>
</div>

When using an acronym to refer to another state department, follow their convention. If in doubt, look at their website to find out how they abbreviate their name.

## Capitalization

Always use sentence case. It’s easier to read and understand. Only capitalize proper nouns and the first word of a sentence or bullet.
Expand Down Expand Up @@ -37,17 +63,6 @@ When writing out a URL, use lowercase letters. But if it’s the first word in a
</div>
</div>

Capitalize acronyms.

<div class="blockquote-container">
<div class="blockquote-body">
<div class="blockquote-header"><strong>Example:</strong></div>
<div class="blockquote-content">
CDC
</div>
</div>
</div>

Capitalize the suffix for time of day, and add a space before it.

<div class="blockquote-container">
Expand Down Expand Up @@ -492,14 +507,6 @@ Use **Black** when referring to people of African descent. Capitalize this where

Use CA.gov when writing about the ecosystem of state websites or the [State of California homepage](https://www.ca.gov/). This follows the California Department of Technology style. Use ca.gov when writing a URL, like digital.ca.gov.

### Cal OES

The **Governor’s Office of Emergency Services** is abbreviated **Cal OES**. This follows the [office’s](https://www.caloes.ca.gov/) style. Write out the full name before using the abbreviation on each page.

### Cal/OSHA

The **California Division of Occupational Safety and Health** is abbreviated **Cal/OSHA**. This follows the [division’s](https://www.dir.ca.gov/dosh/) style. Write out the full name before using the abbreviation on each page.

### county

Use **county** in lowercase when referring to a level of government.
Expand Down Expand Up @@ -641,7 +648,7 @@ Use **Native Hawaiian** when referring to people of Hawaiian descent. This follo

### Office of Data and Innovation

When spelling out the full name of the office, use the word **and**. Do not use an ampersand (&). If you mention ODI more than once in the content, use **(ODI)** after the first use. Use **ODI** for all following references instead of writing out the full name.
When spelling out the full name of the office, use the word **and**. Do not use an ampersand (&).

### OK

Expand Down
2 changes: 2 additions & 0 deletions docs/pages/content-design/recommended-reading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ headericon: bookmark

[Plainlanguage.gov](https://www.plainlanguage.gov/), maintained by the US federal government, is a great resource for how to implement plain language. Their site also includes [examples of plain language](https://www.plainlanguage.gov/examples/) in action.

The [Plain English Lexcion](https://clearest.co.uk/wp-content/uploads/2021/09/Plain_English_LEXICON_June_2011.pdf) has 2,700 substitutions for complex words. Some may be specific to British English.

### Human-centered design

* [Nielsen Norman Group](https://www.nngroup.com/articles/)
Expand Down
Loading