Skip to content

Commit

Permalink
Merge pull request #454 from canada-ca/style-guide-corrections-aug
Browse files Browse the repository at this point in the history
Corrections to style guide
  • Loading branch information
jmealing authored Aug 7, 2024
2 parents 64b6098 + 899f87a commit 89fdc9e
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 10 deletions.
2 changes: 1 addition & 1 deletion common-design-patterns/social-media-channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ title: Social media channels
<summary><strong>Drupal WxT</strong></summary>
<p class="mrgn-tp-lg">For Drupal WxT:</p>
<ul>
<li><a href="https://drupalwxt.github.io/en/">Drupal WxT documentation</a></li>
<li><a href="https://drupalwxt.github.io/">Drupal WxT documentation</a></li>
</ul>
</details>
</div>
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ title: "Canada.ca design system"
<p>User-tested templates, page layouts, design patterns, guidelines, and code samples</p>
</div>
<div class="col-md-4">
<h3 class="h5"><a href="{{ site.url }}/style-guide/">Canada.ca Content Style guide</a></h3>
<h3 class="h5"><a href="{{ site.url }}/style-guide/">Canada.ca Content Style Guide</a></h3>
<p>Writing principles and techniques to make content clear and accessible to all</p>
</div>
<div class="col-md-4">
Expand Down
10 changes: 4 additions & 6 deletions style-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ title: "Canada.ca Content Style Guide"
<h2>Recent updates</h2>
<p>Most recent updates to the guide:</p>
<ul class="mrgn-tp-lg">
<li>We have updated <a href="#toc6">Section 2.0 Communicate clearly with plain language</a> to better align with the plain language standard developed through the International Organization for Standardization (ISO). This update was done in collaboration with plain language experts and communications professionals from across the Government of Canada.</li>
<li>We have updated <a href="#toc6">section 2.0 Communicate clearly with plain language</a> to better align with the plain language standard developed through the International Organization for Standardization (ISO). This update was done in collaboration with plain language experts and communications professionals from across the Government of Canada.</li>
</ul>
<p><a href="update-history.html">Update history</a> (this list begins with changes on May 25, 2023).</p>
</section>
Expand All @@ -54,7 +54,7 @@ title: "Canada.ca Content Style Guide"
<h2>Use of the style guide</h2>
<p>All departments and other portions of the federal public administration subject to the <cite>Directive on the Management of Communications</cite> must use the Canada.ca Style Guide. These organizations must follow this style guide's requirements for all public-facing websites and digital services, regardless of the technology, domain name or publishing platform used. This requirement is referenced in Appendix D: Mandatory Procedures for Social Media and Web Communications in the <a href="https://www.tbs-sct.canada.ca/pol/doc-eng.aspx?id=30682"><cite>Directive on the Management of Communications</cite></a>.</p>
<h3>Out-of-scope situations</h3>
<p>Institutions that fall outside of the Directive on the Management of Communications do not have to follow this style guide. However, all institutions are encouraged to use it for both their internal and external web products. Following this guide's rules and techniques will make it easier for everyone to find, understand and use the government's digital content.</p>
<p>Institutions that fall outside of the <cite>Directive on the Management of Communications</cite> do not have to follow this style guide. However, all institutions are encouraged to use it for both their internal and external web products. Following this guide's rules and techniques will make it easier for everyone to find, understand and use the government's digital content.</p>
</section>
<section id="toc4">
<h2>Related policies, standards and procedures</h2>
Expand Down Expand Up @@ -228,7 +228,7 @@ title: "Canada.ca Content Style Guide"
</div>
<section id="wp2-0">
<h3>The duty to be clear: Plain language requirement</h3>
<p>The use of plain language is a requirement of the <a href="https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=30682">Directive on the Management of Communications</a>.</p>
<p>The use of plain language is a requirement of the <a href="https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=30682"><cite>Directive on the Management of Communications</cite></a>.</p>
<p>Plain language is a writing approach to communicate what your audience needs to know. With plain language, the wording, structure and design are so clear your intended audience can easily:</p>
<ul>
<li><b>find</b> what they need</li>
Expand Down Expand Up @@ -1454,7 +1454,7 @@ title: "Canada.ca Content Style Guide"
<li>do not use the passive voice</li>
<li>it is important to use the right words</li>
<li>use only short sentences and paragraphs</li>
<li>use the Canada.ca Content Style Guide to ensure you have followed the guidelines</li>
<li>use the <cite>Canada.ca Content Style Guide</cite> to ensure you have followed the guidelines</li>
</ul>
<p>Take a look at the <a href="#wp4-1">section on capitalization and punctuation rules that apply to lists</a>.</p>
</section>
Expand Down Expand Up @@ -2396,7 +2396,6 @@ title: "Canada.ca Content Style Guide"
<h3>Case study A: improve plain language and content structure</h3>
<h4>Before</h4>
<p>The Employment Insurance (EI) program offers temporary financial assistance to Canadians and individuals who are legally entitled to work in Canada, have a valid Social Insurance Number and remain in Canada during their benefit period. One type of benefits that the&nbsp;EI&nbsp;program offers is regular benefits.&nbsp;EI&nbsp;regular benefits are offered to people who have lost their employment through no fault of their own (for example, because of a shortage of work or because they were employed in seasonal work) and who are ready, willing, and capable of working each day but unable to find work.</p>
<p>Flesch-Kincaid reading level: 17.2</p>
<h4>After</h4>
<p>The Employment Insurance (EI) program could give you temporary financial help if you lost your job.</p>
<p>To qualify for regular benefits, you must:</p>
Expand All @@ -2407,7 +2406,6 @@ title: "Canada.ca Content Style Guide"
<li>be ready, willing and able to work each day but still can't find work</li>
<li>stay in Canada while you're getting EI help</li>
</ul>
<p>Flesch-Kincaidreading level: 5.9</p>
<h4>What we did</h4>
<p>To improve this content, we:</p>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions style-guide/update-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: "Update history for the Canada.ca Content Style Guide"
---
<p>This list contains all changes made to the Canada.ca Content Style Guide since May 25, 2023.</p>
<h2>August 6, 2024</h2>
<ul><li>We have updated <a href="/style-guide/#toc6">Section 2.0 Communicate clearly with plain language</a> to better align with the plain language standard developed through the International Organization for Standardization (ISO). This update was done in collaboration with plain language experts and communications professionals from across the Government of Canada.</li></ul>
<ul><li>We have updated <a href="/style-guide/#toc6">section 2.0 Communicate clearly with plain language</a> to better align with the plain language standard developed through the International Organization for Standardization (ISO). This update was done in collaboration with plain language experts and communications professionals from across the Government of Canada.</li></ul>
<h2>February 9, 2024</h2>
<ul class="mrgn-tp-lg">
<li>as of January 2024, <cite>The Canadian Style</cite> and <cite>Le guide du rédacteur</cite> were archived, with their content integrated into <a href="https://www.noslangues-ourlanguages.gc.ca/en/writing-tips-plus/index-eng"><cite>Writing Tips Plus</cite></a> and the <span lang=fr><a href="https://www.noslangues-ourlanguages.gc.ca/fr/cles-de-la-redaction/index-fra"><cite>Clés de la rédaction</cite></a></span>. We’ve updated references and links in the following sections:</li>
Expand Down Expand Up @@ -37,7 +37,7 @@ title: "Update history for the Canada.ca Content Style Guide"
<ul class="mrgn-tp-lg">
<li>improved the Figure 5 functional image example in the <a href="/style-guide/#wp6-1-1">Functional images</a> section</li>
<li>updated the example in the <a href="/style-guide/#wp6-1-2">Decorative images</a> section and added information about using null alt text</li>
<li>improved the simple table examples in <a href="/style-guide/#wp5-3">Section 5.3 Use tables to organize data</a></li>
<li>improved the simple table examples in <a href="/style-guide/#wp5-3">section 5.3 Use tables to organize data</a></li>
<li>updated the text under <a href="/style-guide/#toc3">Use of the style guide</a> to highlight that the <cite>Directive on the Management of Communications</cite> is the official source for who must use this guide</li>
<li>updated the text under the heading <a href="/style-guide/#wp1-2-1b">Writing for inclusivity</a> to reflect the new inclusive writing guidelines and resources</li>
<li>added an example for when to capitalize public service under <a href="/style-guide/#wp4-1">4.1 Capitalization and punctuation</a></li>
Expand Down

0 comments on commit 89fdc9e

Please sign in to comment.