Skip to content

Commit

Permalink
Merge pull request #86 from cagov/aug-23-content-design-updates
Browse files Browse the repository at this point in the history
August 23 content design updates
  • Loading branch information
m-sullivan7 authored Aug 23, 2024
2 parents e6091ac + aa60fe8 commit e730141
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
13 changes: 13 additions & 0 deletions docs/pages/content-design/odi-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,19 @@ Twelve cities in Los Angeles County allow cultivation of cannabis.
</div>
</div>

### Telephone numbers

Use hyphens to separate the area code, first 3 digits, and last 4 digits. Do not use parentheses. When it serves the user (like on a webpage), make the telephone number a link.

<div class="blockquote-container">
<div class="blockquote-body">
<div class="blockquote-header"><strong>Example:</strong></div>
<div class="blockquote-content">
You can call the Office of the Governor at <a href="tel:9164452841">916-445-2841</a>.
</div>
</div>
</div>

### Times

Use **AM** and **PM** with times. Put a space between the time and AM or PM. Convert times to the Pacific time zone. Unless your target audience is out of state, do not state the time zone since California is only in one time zone.
Expand Down
12 changes: 9 additions & 3 deletions docs/pages/content-design/recommended-reading.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ These are the style guides we look at when we have a new content question. We’
* [How to write for SF.gov](https://sfdigitalservices.gitbook.io/style-guide/city-standards) (City of San Francisco)
* [Federal plain language guidelines](https://www.plainlanguage.gov/guidelines/) at plainlanguage.gov (federal government)
* 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 words that make your content less clear (UK Government Digital Service).
* [Australian Government Style Manual](https://www.stylemanual.gov.au/)

## How-to's

Expand Down Expand Up @@ -61,10 +61,16 @@ Inclusive language uses words that respect all people. ODI doesn’t maintain ou

[Plainlanguage.gov](https://www.plainlanguage.gov/) is a great resource for how to use plain language. It’s maintained by the US federal government. 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.

The [ClearMark Awards](https://centerforplainlanguage.org/awards/clearmark/) honors the best plain language communications. They’re a great place to find inspiration for your writing. Winners come from government, nonprofit, and business.

#### Word substitution lists

Swapping complex words for simple ones is a big part of plain language. These word substitution lists can help with that.

* Start with [Plainlanguage.gov’s Use simple words and phrases](https://www.plainlanguage.gov/guidelines/words/use-simple-words-phrases/). It covers the most common words.
* [Health Research for Action’s Plain Language Word List](https://multco-web7-psh-files-usw2.s3-us-west-2.amazonaws.com/s3fs-public/PlainLanguageWordList.pdf) has lots of healthcare-specific words.
* The most complete list is the [Plain English Lexicon](https://clearest.co.uk/wp-content/uploads/2021/09/Plain_English_LEXICON_June_2011.pdf). It has 2,700 words. However, some are specific to British English.

### Human-centered design

[Nielsen Norman Group](https://www.nngroup.com/articles/) is a leader in usability research. We like their articles on:
Expand Down

0 comments on commit e730141

Please sign in to comment.