From 967e767edb42fd95c4f7e250f48766f454a912d5 Mon Sep 17 00:00:00 2001 From: Michael Sullivan <69169190+m-sullivan7@users.noreply.github.com> Date: Fri, 23 Aug 2024 10:20:35 -0700 Subject: [PATCH 1/3] Update odi-style-guide.md Adds telephone numbers entry --- docs/pages/content-design/odi-style-guide.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/pages/content-design/odi-style-guide.md b/docs/pages/content-design/odi-style-guide.md index 41bc5069..3146076c 100644 --- a/docs/pages/content-design/odi-style-guide.md +++ b/docs/pages/content-design/odi-style-guide.md @@ -418,6 +418,19 @@ Twelve cities in Los Angeles County allow cultivation of cannabis. +### 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. + +
+
+
Example:
+
+You can call the Office of the Governor at 916-445-2841. +
+
+
+ ### 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. From 96bd7f3e324f41116ae3e43f8bac621f4f39ee29 Mon Sep 17 00:00:00 2001 From: Michael Sullivan <69169190+m-sullivan7@users.noreply.github.com> Date: Fri, 23 Aug 2024 10:24:14 -0700 Subject: [PATCH 2/3] Update recommended-reading.md Add Australian Government Style Manual, remove gov.uk word list, add word substitution list section --- docs/pages/content-design/recommended-reading.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/pages/content-design/recommended-reading.md b/docs/pages/content-design/recommended-reading.md index 39da46f3..55f34a53 100644 --- a/docs/pages/content-design/recommended-reading.md +++ b/docs/pages/content-design/recommended-reading.md @@ -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 @@ -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: From aa60fe803fb3287c3242b1cc55cb1ba6fca41657 Mon Sep 17 00:00:00 2001 From: Michael Sullivan <69169190+m-sullivan7@users.noreply.github.com> Date: Fri, 23 Aug 2024 10:29:59 -0700 Subject: [PATCH 3/3] Update odi-style-guide.md Tel link fix --- docs/pages/content-design/odi-style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/content-design/odi-style-guide.md b/docs/pages/content-design/odi-style-guide.md index 3146076c..9fc22424 100644 --- a/docs/pages/content-design/odi-style-guide.md +++ b/docs/pages/content-design/odi-style-guide.md @@ -426,7 +426,7 @@ Use hyphens to separate the area code, first 3 digits, and last 4 digits. Do not
Example:
-You can call the Office of the Governor at 916-445-2841. +You can call the Office of the Governor at 916-445-2841.