You are viewing a PR preview for PR #1819

Agriculture Design System
Beta
Design System for the Export Service

Content principles

Keep these basic ideas in mind to write Export Service content, or any other content.

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

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

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

Based on user needs

Good content is based on evidence of our users’ needs.

For example, users who need to apply for a permit don’t need to understand the history of changes to related laws.

Understand the primary user need for any service or product and design content to meet it.

Back to top

Plain language

Just less than half of all Australians have a low level of literacy. 1

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. Don’t use abbreviations and unusual 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.

Back to top

Readability

To check how easy your content is to read, use tools like Hemingway Editor. Try to create content with a reading level of 9 or less – the lower, the better.

However, this reading level is only a general indicator. Keep in mind that readability scores can vary across readability tools.

We use Hemingway Editor because it’s simple and free to use. But wherever possible, test the readability of content with users.

Back to top

Concise

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

Back to top

Accessible and inclusive

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

Content must meet requirements in the Web Content Accessibility Guidelines (WCAG) 2.1.

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.

Find more information on creating accessible and inclusive content. To find out how we build accessible components, see Accessibility.

Back to top

Findable

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

Ensure pages in the public Export Service 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.

Back to top

Consistent

Another way of reducing cognitive load is to keep content consistent. Try to keep content across the Export Service in the same voice and tone.

Use the same names for common tasks. For example, ‘sign in’ (instead of ‘log in’) to the Export Service.

To ensure content is consistent, follow our Content styles and Content patterns. This way users will have a seamless end-to-end journey from one page to another.

Back to top

Accurate

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.

Back to top

Comprehensive

Ensure your content covers everything needed to support the page’s primary aim. This might include links to other supporting content or to more details.

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.

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.

Users who just want to complete a task then have relevant content where they need it. But it still meets the needs of those who may want to know more.

Back to top

Contextual

Let users know where they are in the Export Service. You can do this by providing site context, through 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.

Make sure there are clear exit points and navigation to previous or next steps in the user journey. Link to related supporting content.

Back to top

Unique

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. 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 somewhere online link to the authoritative source. For example, the Export Service. Or the Department of Agriculture, Fisheries and Forestry (DAFF) website.

Back to top

Notes

    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:
    • identify, interpret, or evaluate one or more pieces of information, and

    • construct meaning across larger chunks of text or perform multi-step operations, while

    • disregarding irrelevant or inappropriate content to arrive at a decision.

    Source: Australian Bureau of Statistics (2013). Programme for the International Assessment of Adult Competencies, Australia