Skip to content

Commit

Permalink
Update recommended-reading.md
Browse files Browse the repository at this point in the history
Adding context to links
  • Loading branch information
m-sullivan7 authored Jul 10, 2024
1 parent 3a57cc1 commit 68d3c0d
Showing 1 changed file with 40 additions and 36 deletions.
76 changes: 40 additions & 36 deletions docs/pages/content-design/recommended-reading.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,74 +6,78 @@ headerlabel: Recommended reading
headericon: bookmark
---

<p class="text-lead">The Office of Data and Innovation (ODI) periodically reviews and adds new resources. We select resources that are easy for people new to plain language and content design to understand and put into practice.</p>
<p class="text-lead">These resources can show you how to improve your content. They are easy to understand and use, even if you’re new to content design. We review these resources often and occasionally add new ones.</p>

## Principles

* [ODI's content design principles](/content-design/principles/)
* [California Design System principles](https://designsystem.webstandards.ca.gov/principles/)
* [Government Code 6219](https://leginfo.legislature.ca.gov/faces/codes_displaySection.xhtml?sectionNum=6219.&lawCode=GOV), California’s plain language law
* [US Web Design System principles](https://designsystem.digital.gov/design-principles/)
* [ODI's content design principles](/content-design/principles/) are broad guidance for writing good content. Each principle contains tips you can use right now in your writing.
* [California Design System principles](https://designsystem.webstandards.ca.gov/principles/) are about designing good services. They can inform team or department values.
* [Government Code 6219](https://leginfo.legislature.ca.gov/faces/codes_displaySection.xhtml?sectionNum=6219.&lawCode=GOV) is California’s plain language law. Share it with stakeholders so they know the importance of writing in plain language.
* [US Web Design System principles](https://designsystem.digital.gov/design-principles/) are service design standards from the federal government. They can be a good supplement to the California Design System principles.

## Online courses

* Cake Consultancy’s [Content design pathway course](https://cakeconsultancy.com/product/content-design-pathway-course/)
* Cake Consultancy’s [Content design pathway course](https://cakeconsultancy.com/product/content-design-pathway-course/) is a 3-5 hour paid self-paced course. It’s a great overview of content design from a UK-based design firm.

## 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://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
These are the style guides we look at when we have a new content question. We’ve organized them in order of preference.

* [Associated Press (AP) Style](https://store.stylebooks.com/) is ODI’s default for style questions not covered by [our style guide](/content-design/odi-style-guide/).
* [18F content guide](https://guides.18f.gov/content-guide/) (federal government)
* [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 some words that make your content less clear, created by a UK government content team
* [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).

## How-to's

### Accessibility

* [Web Accessibility Toolkit](https://dor.ca.gov/Home/WebAccessibilityToolkit) - California Department of Rehabilitation
* Web Accessibility Initiative
* [Cognitive Accessibility Guidance](https://www.w3.org/WAI/WCAG2/supplemental/#-cognitive-accessibility-guidance)
* [An alt decision tree](https://www.w3.org/WAI/tutorials/images/decision-tree/)
* [How to: write good Alt Text](https://supercooldesign.co.uk/blog/how-to-write-good-alt-text) - Supercool
* [Web Accessibility Toolkit](https://dor.ca.gov/Home/WebAccessibilityToolkit) is a comprehensive guide to digital accessibility at the state. It’s maintained by Disability Works California (formerly the Department of Rehabilitation).
* Web Accessibility Initiative is the leading internet accessibility standards organization.
* [Cognitive Accessibility Guidance](https://www.w3.org/WAI/WCAG2/supplemental/#-cognitive-accessibility-guidance). It helps you make content understood by people with cognitive and learning disabilities.
* [An alt decision tree](https://www.w3.org/WAI/tutorials/images/decision-tree/) is a tool we use when deciding whether an image needs to have alt text.
* [How to: write good Alt Text](https://supercooldesign.co.uk/blog/how-to-write-good-alt-text) is good general guidance for writing alt text.

### Content design

* [Why FAQs aren’t the answer you’re looking for](https://digitalblog.coop.co.uk/2018/09/13/why-faqs-arent-the-answer-youve-been-looking-for/) - Co-op
* [A guide to content design](https://design.shelter.org.uk/digital-framework/a-guide-to-content-design) - Shelter, a UK housing nonprofit
* [What is content design?](https://design.shelter.org.uk/digital-framework/a-guide-to-content-design#Aguidetocontentdesign-Whatiscontentdesign?)
* [Crits](https://design.shelter.org.uk/digital-framework/a-guide-to-content-design#Aguidetocontentdesign-Crits)
* [How content designers can convince subject matter experts content needs to change](https://medium.com/@WordsThatServe/how-content-designers-can-convince-subject-matter-experts-content-needs-to-change-522bde5fc6eb) - Lee Baker on Medium
* [Why FAQs aren’t the answer you’re looking for](https://digitalblog.coop.co.uk/2018/09/13/why-faqs-arent-the-answer-youve-been-looking-for/) has good points about why FAQs don’t help readers. We borrow from them when we talk with stakeholders.
* [A guide to content design](https://design.shelter.org.uk/digital-framework/a-guide-to-content-design) is a great handbook on writing by Shelter, a UK housing nonprofit. In particular, we like these sections:
* [What is content design?](https://design.shelter.org.uk/digital-framework/a-guide-to-content-design#Aguidetocontentdesign-Whatiscontentdesign?) is a useful definition for people new to the field.
* [Crits](https://design.shelter.org.uk/digital-framework/a-guide-to-content-design#Aguidetocontentdesign-Crits): what a content crit is and how to run them.
* [How content designers can convince subject matter experts content needs to change](https://medium.com/@WordsThatServe/how-content-designers-can-convince-subject-matter-experts-content-needs-to-change-522bde5fc6eb). This has advice that can help you advocate for better content.

### Inclusive language

* The University of Washington’s [IT inclusive language guide](https://itconnect.uw.edu/guides-by-topic/identity-diversity-inclusion/inclusive-language-guide/): terms often found in IT, with alternatives
* Atlassian’s [inclusive language guide](https://atlassian.design/content/inclusive-writing): alternatives to many terms and phrases
* Vox Media’s [Language, Please](https://languageplease.org/): a resource that defines many terms. In some cases it offers guidance on choosing terms
* Service Design Network’s [Supporting inclusive forms design with design systems](https://www.service-design-network.org/community-knowledge/supporting-inclusive-form-design-with-design-systems)
Inclusive language uses words that respect all people. ODI doesn’t maintain our own inclusive language guide. We consult these guides when we have questions:

* The University of Washington’s [IT inclusive language guide](https://itconnect.uw.edu/guides-by-topic/identity-diversity-inclusion/inclusive-language-guide/). It has terms often found in IT, with alternatives.
* Atlassian’s [inclusive language guide](https://atlassian.design/content/inclusive-writing) gives alternatives to many terms and phrases.
* Vox Media’s [Language, Please](https://languageplease.org/) defines many terms and gives history about them. In some cases it offers guidance on choosing terms.
* Service Design Network’s [Supporting inclusive forms design with design systems](https://www.service-design-network.org/community-knowledge/supporting-inclusive-form-design-with-design-systems). It talks about how to make inclusive language the default when making forms.

### Plain language

[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.
[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.

### Human-centered design

* [Nielsen Norman Group](https://www.nngroup.com/articles/)
* [Content strategy](https://www.nngroup.com/topic/content-strategy/)
* [Information architecture](https://www.nngroup.com/topic/information-architecture/)
* [Writing for the web](https://www.nngroup.com/topic/writing-web/)
* [Web usability](https://www.nngroup.com/topic/web-usability/)
* [Why you only need to test with 5 users](https://www.nngroup.com/articles/why-you-only-need-to-test-with-5-users/)
* [Nielsen Norman Group](https://www.nngroup.com/articles/) is a leader in usability research. We like their articles on:
* [Content strategy](https://www.nngroup.com/topic/content-strategy/) (the high-level plan for creating and managing content)
* [Information architecture](https://www.nngroup.com/topic/information-architecture/) (how to organize a website)
* [Writing for the web](https://www.nngroup.com/topic/writing-web/) (general advice on writing)
* [Web usability](https://www.nngroup.com/topic/web-usability/) (user experience research, helpful for putting content design in context)
* [Why you only need to test with 5 users](https://www.nngroup.com/articles/why-you-only-need-to-test-with-5-users/) shows why you don’t need to do big usability tests with your content. Use this to persuade stakeholders you can quickly gather feedback before publishing content.

## Tools

* [Hemingway Editor](http://hemingwayapp.com/)
* [ODI’s plain language checklist](/content-design/plain-language-checklist/): detailed guidance on how to improve your writing
* [Hemingway Editor](http://hemingwayapp.com/) is ODI’s favorite writing assistant. Its web version is free and highlights areas for improvement in real time.
* [ODI’s plain language checklist](/content-design/plain-language-checklist/) has 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
* [Content Design](https://contentdesign.london/shop/content-design-by-sarah-winters-paperback) by Sarah Winters is our pick if you want only one book on content design. It covers everything from starting out to building organizational support for content design.
* [Writing for dollars, writing to please: The case for plain language in business, government, and law](https://a.co/d/3bHM6Md) by Joseph Kimble. This is our go-to reference when we run into legal or technical objections to plain language. The author is an attorney and longtime plain language advocate. He refutes many common arguments against using plain language.

0 comments on commit 68d3c0d

Please sign in to comment.