diff --git a/style-guide/index.md b/style-guide/index.md index c15bad2649..14eb7f3549 100644 --- a/style-guide/index.md +++ b/style-guide/index.md @@ -1,7 +1,7 @@ --- altLangPage: "https://conception.canada.ca/guide-redaction" date: 2017-10-05 -dateModified: 2023-08-24 +dateModified: 2023-10-12 description: "These are the rules to create web content that can be easily found, understood and used." title: "Canada.ca Content Style Guide" --- @@ -272,255 +272,273 @@ title: "Canada.ca Content Style Guide"
Write: Present your passport to the border officer.
Instead of: According to Canadian legislation, you're required to present your passport to the agent who will welcome you into the country.
Replace long words with short, simple and everyday words that most people understand and use. Simple words have 2 syllables or less. They're easier to scan than long, complex words.
-Write: ask
- Instead of: make a request
Write: you must
- Instead of: you shall
Write: to
- Instead of: in order to
Write: before
- Instead of: prior to
Write: get
- Instead of: obtain
See how this rule applies to content in French
- +Whenever possible use the:
-In an active sentence, the subject does the action. The sentence is clear and direct.
-In a passive sentence, it may not be clear who or what is doing the action.
-Active: We may ask you to provide proof of citizenship.
- Passive: You may be asked to provide proof of citizenship.
Whenever possible, tell people what they may or must do instead of what they may not or must not do. Avoid negatives, double negatives and exceptions to exceptions.
-Positive: You're entitled to part of the deduction.
- Negative: You're not entitled to the entire deduction.
Positive: The procedure will be effective.
- Double negative: The procedure will not be ineffective.
Positive: You may claim a child born in 1972 or earlier as a dependent, if he or she has a mental or physical disability.
- Double negative: You may not claim anything for a dependent child born in 1972 or earlier, unless the child has a mental or physical disability.
If something has serious consequences, you can use the negative form to explain that something isn't possible or should not be done.
-Write: Do not try to locate the source of carbon monoxide. Leave your home immediately and move to fresh air.
- -Replace long words with short, simple and everyday words that most people understand and use. Simple words have 2 syllables or less. They're easier to scan than long, complex words.
+Write: ask
+ Instead of: make a request
Write: you must
+ Instead of: you shall
Write: to
+ Instead of: in order to
Write: before
+ Instead of: prior to
Write: get
+ Instead of: obtain
Whenever possible use the:
+In an active sentence, the subject does the action. The sentence is clear and direct.
+In a passive sentence, it may not be clear who or what is doing the action.
+Active: We may ask you to provide proof of citizenship.
+ Passive: You may be asked to provide proof of citizenship.
Avoid using nouns that are formed from verbs. They can be vague. Verbs alone clearly express the action needed.
-Write: apply
- Instead of: submit your application
Write: consider
- Instead of: take into consideration
Write: modify
- Instead of: make a modification
Write: needs
- Instead of: is in need of
Always use the simplest form of a verb. When possible, use the present tense.
- +Whenever possible, tell people what they may or must do instead of what they may not or must not do. Avoid negatives, double negatives and exceptions to exceptions.
+Positive: You're entitled to part of the deduction.
+ Negative: You're not entitled to the entire deduction.
Positive: The procedure will be effective.
+ Double negative: The procedure will not be ineffective.
Positive: You may claim a child born in 1972 or earlier as a dependent, if he or she has a mental or physical disability.
+ Double negative: You may not claim anything for a dependent child born in 1972 or earlier, unless the child has a mental or physical disability.
If something has serious consequences, you can use the negative form to explain that something isn't possible or should not be done.
+Write: Do not try to locate the source of carbon monoxide. Leave your home immediately and move to fresh air.
Where possible, avoid using jargon, idioms and expressions. Use the clearest, most popular term for your audience.
-Legal and technical terms and "government-speak" confuse most people.
-People who don't speak English or French might use online tools to translate text. These tools don't always translate idioms and expressions accurately.
-Jargon: bench warrant (an order by a judge to arrest someone who didn't show up in court or comply with certain conditions)
-Idiom: to hire a helping hand (meaning to hire an employee)
-Expression: attack your least favourite task first (meaning do your least favourite task first)
-If you must include jargon familiar to your target audience, be sure to:
-Write: You have to file your income tax return (T1) by April 30.
- Instead of: You have to file your T1 return by April 30.
Write: Learn about savings plans that can help you save enough money to retire.
- Instead of: Learn about different types of savings plans that will let you build up your retirement nest egg.
Tools you can use to see which search terms are most popular:
-Refer to your analytics to find out which search terms your audience uses to find related content.
- -Keep sentence structure simple by putting the subject and the verb at the beginning of the sentence and by using the subject + verb + object construction. This structure helps the reader understand what the subject of the sentence is doing by placing the subject first, followed by the verb.
-Avoid complex and compound sentences. They generally contain too much information for people to understand when they're scanning.
-Write: Learn about Canada's transportation system. Find information about using paved roads, bike trails, airports and ports across the country.
- Instead of: Canada's vast transportation system enables millions of people each year to travel throughout the country, around the world, and to work and back. From this page you can access a wealth of transportation information related to travelling and commuting.
Replace complex sentence structures with direct statements.
-Write: You have until April 30 to file your tax return.
- Instead of: The period of time that you have to file your tax return ends on April 30.
Replace noun strings (a series of 2 or more nouns used to name something) with direct statements.
-Write: The evaluation team will submit its final report on the training program in September.
- Instead of: The training program evaluation team will submit its final report in September.
Surround a long sentence with shorter ones because it helps people understand the long sentence.
- +Avoid using nouns that are formed from verbs. They can be vague. Verbs alone clearly express the action needed.
+Write: apply
+ Instead of: submit your application
Write: consider
+ Instead of: take into consideration
Write: modify
+ Instead of: make a modification
Write: needs
+ Instead of: is in need of
Always use the simplest form of a verb. When possible, use the present tense.
+Where possible, avoid using jargon, idioms and expressions. Use the clearest, most popular term for your audience.
+Legal and technical terms and "government-speak" confuse most people.
+People who don't speak English or French might use online tools to translate text. These tools don't always translate idioms and expressions accurately.
+Jargon: bench warrant (an order by a judge to arrest someone who didn't show up in court or comply with certain conditions)
+Idiom: to hire a helping hand (meaning to hire an employee)
+Expression: attack your least favourite task first (meaning do your least favourite task first)
+If you must include jargon familiar to your target audience, be sure to:
+Write: You have to file your income tax return (T1) by April 30.
+ Instead of: You have to file your T1 return by April 30.
Write: Learn about savings plans that can help you save enough money to retire.
+ Instead of: Learn about different types of savings plans that will let you build up your retirement nest egg.
Tools you can use to see which search terms are most popular:
+Refer to your analytics to find out which search terms your audience uses to find related content.
+Keep sentence structure simple by putting the subject and the verb at the beginning of the sentence and by using the subject + verb + object construction. This structure helps the reader understand what the subject of the sentence is doing by placing the subject first, followed by the verb.
+Avoid complex and compound sentences. They generally contain too much information for people to understand when they're scanning.
+Write: Learn about Canada's transportation system. Find information about using paved roads, bike trails, airports and ports across the country.
+ Instead of: Canada's vast transportation system enables millions of people each year to travel throughout the country, around the world, and to work and back. From this page you can access a wealth of transportation information related to travelling and commuting.
Replace complex sentence structures with direct statements.
+Write: You have until April 30 to file your tax return.
+ Instead of: The period of time that you have to file your tax return ends on April 30.
Replace noun strings (a series of 2 or more nouns used to name something) with direct statements.
+Write: The evaluation team will submit its final report on the training program in September.
+ Instead of: The training program evaluation team will submit its final report in September.
Surround a long sentence with shorter ones because it helps people understand the long sentence.
+Be concise. Use as few words as possible to express an idea. By being concise, you'll help everyone, even specialists, complete the task they set out to do.
+Keep sentences and paragraphs short to make them easier to scan on any screen size. People who have learning disabilities may find it difficult to scan and understand long sentences and paragraphs.
+Try to keep sentences under 20 words. You can do this by:
+Write: We received your request for funding and approved it.
+ Instead of: We received your request for funding, which we've thoroughly reviewed and approved in a timely manner.
Write: We'll consider any type of investment.
+ Instead of: Any type of investment will be taken into consideration.
Try to keep paragraphs to 3 sentences. You can do this by:
+When explaining a requirement that comes from an act or regulation, avoid mentioning the act or regulation by name. Include only the information people need to complete the task.
+If you must include the name of the act or regulation, always give a plain-language description. First, explain what your audience needs to know and why they need to know more about the act or regulation. Then, you may add the reference to the act or regulation.
+Write: You can apply for your child to become a Canadian citizen after they arrive in Canada as a permanent resident.
+Related links
+Instead of: After your child arrives in Canada as a permanent resident, you can apply for citizenship on the child's behalf under section 5.1 of the Citizenship Act.
+Check the reading level of your text. Make sure that it meets the reading level you're targeting based on the literacy needs of your audience. Do this every so often while you're writing content. You can use various tools to do this.
+Readability tools help you check if content is too wordy or complex. Writing content at a reading level above grade 8 can make it difficult for many people to understand or complete their task.
+You can use a readability tool like Flesch-Kincaid to check the reading level of your English content. This tool is available as part of Microsoft Word. It generally reflects the years of education needed to understand the text.
+To use Flesch-Kincaid:
+You can check the reading level of a whole page or just part of a page. To check the reading level:
+If your text contains technical terms that consist of long, multi-syllable words that you need to use for your specialized audience, remove these terms before you test the content for readability to see whether the surrounding text can be simplified. Reinsert the technical terms once you've simplified the surrounding text.
+The Readability Statistics dialog box will appear and show the Flesch-Kincaid grade level.
+ +In newer versions of Microsoft Word, search for "Flesch-Kincaid" using the help feature.
Be concise. Use as few words as possible to express an idea. By being concise, you'll help everyone, even specialists, complete the task they set out to do.
-Keep sentences and paragraphs short to make them easier to scan on any screen size. People who have learning disabilities may find it difficult to scan and understand long sentences and paragraphs.
-Try to keep sentences under 20 words. You can do this by:
+Evaluate the reading level of content as follows for:
Write: We received your request for funding and approved it.
- Instead of: We received your request for funding, which we've thoroughly reviewed and approved in a timely manner.
Write: We'll consider any type of investment.
- Instead of: Any type of investment will be taken into consideration.
Try to keep paragraphs to 3 sentences. You can do this by:
+Readability tools reveal the reading level of your content, but they can't tell you whether it makes sense.
+To check whether your content is easy to read and understand, test it:
When explaining a requirement that comes from an act or regulation, avoid mentioning the act or regulation by name. Include only the information people need to complete the task.
-If you must include the name of the act or regulation, always give a plain-language description. First, explain what your audience needs to know and why they need to know more about the act or regulation. Then, you may add the reference to the act or regulation.
-Write: You can apply for your child to become a Canadian citizen after they arrive in Canada as a permanent resident.
-Related links
+If your content has a high reading level, or if usability testing shows low task completion, try to:
Instead of: After your child arrives in Canada as a permanent resident, you can apply for citizenship on the child's behalf under section 5.1 of the Citizenship Act.
- -Check the reading level of your text. Make sure that it meets the reading level you're targeting based on the literacy needs of your audience. Do this every so often while you're writing content. You can use various tools to do this.
-Readability tools help you check if content is too wordy or complex. Writing content at a reading level above grade 8 can make it difficult for many people to understand or complete their task.
-You can use a readability tool like Flesch-Kincaid to check the reading level of your English content. This tool is available as part of Microsoft Word. It generally reflects the years of education needed to understand the text.
-To use Flesch-Kincaid:
-You can check the reading level of a whole page or just part of a page. To check the reading level:
-If your text contains technical terms that consist of long, multi-syllable words that you need to use for your specialized audience, remove these terms before you test the content for readability to see whether the surrounding text can be simplified. Reinsert the technical terms once you've simplified the surrounding text.
-The Readability Statistics dialog box will appear and show the Flesch-Kincaid grade level.
- -In newer versions of Microsoft Word, search for "Flesch-Kincaid" using the help feature.
-Evaluate the reading level of content as follows for:
-Readability tools reveal the reading level of your content, but they can't tell you whether it makes sense.
-To check whether your content is easy to read and understand, test it:
-If your content has a high reading level, or if usability testing shows low task completion, try to:
-Instead of: How do I renew my passport?
You may use "my" in content, page titles and links for proper names (such as My Service Canada Account).
-Write: If you plan to travel to or transit through the United States, find out about the rules you need to follow from U.S. Customs and Border Protection.
Instead of: If you plan to travel to or transit through the U.S., CBSA encourages you to visit the U.S. Customs and Border Protection website for information on the U.S. Western Hemisphere Travel Initiative, and the requirements for entering or returning to the U.S.
See how this rule applies to content in French
- +See how this rule applies to content in French
- +Formatting must support the most important information on the page.
-Don't combine styles, like underlining and bold formatting, unless it's part of the hyperlinked text found on a topic page.
-Use underlining for links only.
-Use bold for emphasis, but use it sparingly: the more you use it, the less effective it is.
-People with dyslexia or other reading disorders may find it difficult to read italicized text.
-Don't use italics:
-Follow The Canadian Style's rules for applying italics for the following:
-Some symbols make web content more difficult to read while others improve readability. Research whether they're understood by a wide audience before using them.
-Don't use an abbreviation or acronym unless it's better known to the widest audience than its long-form equivalent. For example:
-Check your analytics to find out what keywords your audiences are using to find your content.
-If you have to use a multi-word term more than once on a web page, use the full term the first time you use it. For any further uses of the term:
-Always spell out an abbreviation the first time you use it on a page.
-Write: There are 15 client contact centres across Canada.
- Instead of: There are 15 CCCs across Canada.
Write: The act strengthens the Government of Canada's commitment to…
- Instead of: The EEA strengthens the Government of Canada's commitment to…
Include abbreviations that your audience uses in your metadata (for example, in the description field) to help search engines find your page more easily.
-If your content contains a lot of abbreviations and acronyms, rethink its structure. Consider placing related content under distinct headings and sections.
-For example, when introducing legal requirements, use the title of the act once, if necessary, and then talk about what people "must" do. The context will make it clear that the things they "must" do are requirements under the act. Don't use the abbreviation for the act, because it makes the text harder to follow.
-Close the topic before referring to other obligations under different legislation.
-Avoid using e.g. and i.e. Use clearer alternatives instead, for example:
-Write: for example, such as, or like
- Instead of: e.g.
Write: that is, in other words
- Instead of: i.e.
You may use these abbreviations when space is limited, for example, in a table or a figure.
-Use contractions that people use when they speak. They're easier to scan than the full form.
-Use most positive contractions of auxiliary verbs. For example:
-Use some negative contractions of auxiliary verbs. For example:
-Use, but don't confuse:
+Uncommon or more complex contractions can be harder for people with low literacy skills to understand.
-Don't use:
-Don't use contractions when there is a critical difference between two things, for example, between doing and not doing something.
-Critical: Do not drive while taking this medicine.
- Not critical: Most people don't have reactions to the flu vaccine.
This rule doesn't apply in French.
- +Write: July 31, 2016, or just July 31 if the year is already clear
- Instead of: July 31st, 2016, or July 31st
Use non-breaking hyphens (Ctrl+Shift+Hyphen) in phone numbers. For example:
-Formatting must support the most important information on the page.
+Don't combine styles, like underlining and bold formatting, unless it's part of the hyperlinked text found on a topic page.
+Use underlining for links only.
+Use bold for emphasis, but use it sparingly: the more you use it, the less effective it is.
+People with dyslexia or other reading disorders may find it difficult to read italicized text.
+Don't use italics:
+Follow The Canadian Style's rules for applying italics for the following:
+Some symbols make web content more difficult to read while others improve readability. Research whether they're understood by a wide audience before using them.
+Don't use an abbreviation or acronym unless it's better known to the widest audience than its long-form equivalent. For example:
+Check your analytics to find out what keywords your audiences are using to find your content.
+If you have to use a multi-word term more than once on a web page, use the full term the first time you use it. For any further uses of the term:
+Always spell out an abbreviation the first time you use it on a page.
+Write: There are 15 client contact centres across Canada.
+ Instead of: There are 15 CCCs across Canada.
Write: The act strengthens the Government of Canada's commitment to…
+ Instead of: The EEA strengthens the Government of Canada's commitment to…
Include abbreviations that your audience uses in your metadata (for example, in the description field) to help search engines find your page more easily.
+If your content contains a lot of abbreviations and acronyms, rethink its structure. Consider placing related content under distinct headings and sections.
+For example, when introducing legal requirements, use the title of the act once, if necessary, and then talk about what people "must" do. The context will make it clear that the things they "must" do are requirements under the act. Don't use the abbreviation for the act, because it makes the text harder to follow.
+Close the topic before referring to other obligations under different legislation.
+Avoid using e.g. and i.e. Use clearer alternatives instead, for example:
+Write: for example, such as, or like
+ Instead of: e.g.
Write: that is, in other words
+ Instead of: i.e.
You may use these abbreviations when space is limited, for example, in a table or a figure.
Use contractions that people use when they speak. They're easier to scan than the full form.
+Use most positive contractions of auxiliary verbs. For example:
+Use some negative contractions of auxiliary verbs. For example:
+Use, but don't confuse:
+Uncommon or more complex contractions can be harder for people with low literacy skills to understand.
+Don't use:
+Don't use contractions when there is a critical difference between two things, for example, between doing and not doing something.
+Critical: Do not drive while taking this medicine.
+ Not critical: Most people don't have reactions to the flu vaccine.
[Organization name or person name]
- [Additional delivery information]
- [Suite or office]-[Civic number] [Street name] [Abbreviated street type] [Abbreviated street direction]
- [City] [Two-letter province or territory abbreviation] [Postal code]
Integrity Regime
- Departmental Oversight Branch
- Public Services and Procurement Canada
- Portage III Tower A 10A1
- 105-11 Laurier St
- Gatineau QC K1A 0S5
Spell out email addresses instead of embedding them within your text.
-Write:
+ +Write: July 31, 2016, or just July 31 if the year is already clear
+ Instead of: July 31st, 2016, or July 31st
Instead of: Email us to submit a request.
-Use non-breaking hyphens (Ctrl+Shift+Hyphen) in phone numbers. For example:
+[Organization name or person name]
+ [Additional delivery information]
+ [Suite or office]-[Civic number] [Street name] [Abbreviated street type] [Abbreviated street direction]
+ [City] [Two-letter province or territory abbreviation] [Postal code]
Integrity Regime
+ Departmental Oversight Branch
+ Public Services and Procurement Canada
+ Portage III Tower A 10A1
+ 105-11 Laurier St
+ Gatineau QC K1A 0S5
Words and expressions in transition are those written commonly in 2 or more different ways. Reduce confusion by using the following spellings:
+Spell out email addresses instead of embedding them within your text.
+Write:
This rule doesn't apply to content in French.
- -Instead of: Email us to submit a request.
Words and expressions in transition are those written commonly in 2 or more different ways. Reduce confusion by using the following spellings:
+This rule doesn't apply to content in French.
+Description metadata field: The description metatdata is the content you see under the blue hyperlinked text in search results. Avoid listing only keywords, because search engines might ignore these. Write 1 or 2 short sentences that summarize the page. Make sure they contain keywords that people use when searching for your content (for example, abbreviations familiar to your audience).
Refer to the section on plain language for tips on using simple and common words as keywords.
See how this rule applies to content in French
- +For example, listing provinces and territories in alphabetical order could be appropriate.
If you present content in alphabetical order in English, also present it in alphabetical order in French to provide the same intuitive experience.
See how this rule applies to content in French
- +See how this rule applies to content in French
- +Decorative images don't require additional information to make them accessible or visible to search engines. Use the null indicator as the alternative text (alt="").
-See how this rule applies to content in French
- +Work with your web team to determine the best way to include the long description information. They'll guide you on how to make sure the image is accessible to people using assistive technology. They'll also ensure that your image meets the Canada.ca Content and Information Architecture Specification.
-See how this rule applies to content in French
- +See how this rule applies to content in French
- +Providing links to other relevant web pages can help people find related information quickly. Links to your pages from other pages may also help improve where your page ranks in search results.
Be sure to select related links carefully. Too many links on a page can cause people to leave the page without reading important information or can discourage them from completing a task.
See how this rule applies to content in French
- +To ensure that you are paid the maximum Employment Insurance (EI) benefit rate that you are entitled to, complete the Claimant Attestation - Highest Weeks of Insurable Earnings (Variable Best Weeks) form with the required information about your highest weeks of insurable earnings in the last 52 weeks of employment or since the start of your last claim, whichever is the shorter period of the two.
See how this rule applies to content in French
- +Make sure that your links work. Check that they take people to the correct page, which contains up-to-date information, in the appropriate official language. Links that don't work frustrate people and hurt the credibility of your content.
-See how this rule applies to content in French
- +Write: Find out how to renew your French passport while abroad in Canada (French only).
-See how this rule applies to content in French
- +In most cases, public-facing content should not link to content that is accessible only through internal government networks. Occasionally, the audience for content that is accessible to the public may be primarily internal.
When a link leads to content available only on internal government networks, write "(accessible only on the Government of Canada network)."
- -See how this rule applies to content in French
- +