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.

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

audit updates to Content-principles and links added #1819

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/clean-mugs-burn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@ag.ds-next/docs": patch
---

docs: audit updates to Content-principles and links added
30 changes: 15 additions & 15 deletions docs/content/content/content-principles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ order: 1

You can use these standards to guide you to create content that is clear and effective.

Good content reduces the cognitive load on users and helps them achieve their aims more easily.
Good content reduces the cognitive load on users. It helps them achieve their aims more easily.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weirdly, having a new sentence for "It" seems to increase cognitive load for me 😅

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Suzanne-aff As discussed


It provides everything users need to complete their task. But it does not increase their cognitive load with details they don’t.

Expand All @@ -27,7 +27,7 @@ Just less than half of all Australians have a low level of literacy. <sup><a ari

Those people who read at a high level of literacy don’t want to spend any more time to do a task than they need to. Everyone benefits from plain language.

When you write and design content, use plain English. It should be as simple and clear as possible while still meeting the needs of users. Use short and simple words where you can.
When you write and design content, use plain English. It should be as simple and clear as possible while still meeting the needs of users. Use short and simple words where you can. Don’t use [abbreviations](/content/content-styles#abbreviations) and [unusual words](/content/content-styles#types-of-words) if you can avoid it.

For more information, see the ‘Writing in plain English’ section of the Writing guidance page (internal DAFF staff only). You can find it on DAFF’s intranet site, The source.

Expand All @@ -47,7 +47,7 @@ We use Hemingway Editor because it’s simple and free to use. But wherever poss

Keep your sentences short. Bullet points can improve readability and make it easier for users to digest content. Use them to break up text and highlight list elements.

Limit paragraphs to just a few sentences. White space – the area on a web page around the text and other content – is an effective way to help make content accessible and keep cognitive load low.
Limit paragraphs to just a few sentences. White space – the area on a web page around text and other content – is an effective way to make content accessible. It keeps cognitive load low.

Good use of white space on a page allows users to easily skim-read content to find what they are looking for. Try to keep white space in mind when you write. Avoid creating ‘walls of text’.

Expand All @@ -57,7 +57,7 @@ Good use of white space on a page allows users to easily skim-read content to fi

All government web content must by law meet accessibility standards. This ensures that everyone can read and understand it.

We encourage you to meet the requirements in the [Web Content Accessibility Guidelines (WCAG) 2.1](https://www.w3.org/TR/WCAG21/).
Content must meet requirements in the [Web Content Accessibility Guidelines (WCAG) 2.1](https://www.w3.org/TR/WCAG21/).

Content also needs to be inclusive. That is, cater for the diverse backgrounds and circumstances of our users. Avoid language that conveys stereotypes and prejudice.

Expand All @@ -69,7 +69,7 @@ Find more information on creating [accessible and inclusive content](https://www

Many users come to content from search engines or site search. That means content needs to be found easily.

Ensure pages have descriptive headings if you create them for the public [Export Service](https://exports.agriculture.gov.au/) site. They should reflect the language of users and describe what is on the page clearly.
Ensure pages in the public [Export Service](https://exports.agriculture.gov.au/) have descriptive headings. They should reflect the language of users and describe what is on the page clearly.

The first heading (H1) at the top of the page should be unique. It’s also an important ranking factor for pages in search engines.

Expand All @@ -87,7 +87,7 @@ To ensure content is consistent, follow our [Content styles](./content-styles) a

## Accurate

Content must be factually correct. Ensure you research content from credible sources and cross-check multiple sources of truth if you need to.
Content must be factual and correct. Ensure you research content from credible sources. You should cross-check across several sources of truth if you need to.

Check content with any relevant subject matter experts and make sure they confirm its accuracy.

Expand All @@ -99,7 +99,7 @@ Ensure your content covers everything needed to support the page’s primary aim

But too much information can overwhelm users and increase their cognitive load. That is, provide more information than a user’s working memory can hold in the moment.

If you think some users might want more detail than what’s necessary, use ‘progressive disclosure’. Progressive disclosure means providing content in stages.
Some users might want more detail than what’s necessary. If this is the case, you can use ‘progressive disclosure’. Progressive disclosure means providing content in stages.

Offer essential content to the user first. Provide any details that are relevant – but not essential – next on the same page, or by linking to another.

Expand All @@ -109,7 +109,7 @@ Users who just want to complete a task then have relevant content where they nee

## Contextual

Let users know where they are on in the Export Service by providing site context, through [breadcrumbs](/components/breadcrumbs) or other means.
Let users know where they are in the Export Service. You can do this by providing site context, through [breadcrumbs](/components/breadcrumbs) or other means.

Ensure the user has access to the right content when they need it, at each stage of their journey. It should be the least amount of information they need to ‘do the thing’ in the Export Service.

Expand All @@ -119,13 +119,13 @@ Make sure there are clear exit points and navigation to previous or next steps i

## Unique

While content should be consistent across the Export Service, it should not be uniform or duplicated.
Content should be consistent across the Export Service. But that does not mean it should be uniform or duplicated.

Avoid using significant chunks of the same content across pages. It’s a bad user experience and may lower page rankings in search engine results.

Content for each web page should be unique so users and search engines can clearly understand the difference between them and easily select a relevant page.
Content for each web page should be unique. Users and search engines can then clearly understand the difference between pages. It allows them to easily select a relevant page.

If content already appears on the Export Service or the [Department of Agriculture, Fisheries and Forestry](https://www.agriculture.gov.au/) (DAFF) website, link to the authoritative source.
If content already appears somewhere online link to the authoritative source. For example, the [Export Service](https://exports.agriculture.gov.au/). Or the [Department of Agriculture, Fisheries and Forestry](https://www.agriculture.gov.au/) (DAFF) website.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feels weird starting this sentence with "or", shouldn't it just be a continuation? For example, the Export Service of the DAFF website

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Suzanne-aff As discussed


<BackToTop />

Expand All @@ -144,9 +144,9 @@ If content already appears on the Export Service or the [Department of Agricultu

<FootnotesList>
<li id="cite-1">
The ABS reports that approximately 45% of Australians over 15 years (or 7.3
million people) have literary skills of level 2 or below. They can’t
complete tasks where they need to:
1. The ABS reports that 7.3 million people have lower-level literacy.
Approximately 45% of Australians over 15 years have literary skills of level
2 or below. They can’t complete tasks where they need to:
<ul>
<li>
identify, interpret, or evaluate one or more pieces of information, and
Expand All @@ -160,7 +160,7 @@ If content already appears on the Export Service or the [Department of Agricultu
decision.
</li>
</ul>
Source: Australian Bureau of Statistics (2013)[Programme for the
Source: Australian Bureau of Statistics (2013). [Programme for the
International Assessment of Adult Competencies,
Australia](https://www.abs.gov.au/ausstats/[email protected]/Lookup/4228.0main+features202011-12)
</li>
Expand Down
Loading