About Waterloo.ca

We're rebuilding Waterloo.ca to provide more accessible online services to the community. Our goal is to clearly describe services we provide and make them easier to use. Contact the project team at website@waterloo.ca


On this page

  1. Accessibility
  2. Rights management
  3. Website ownership
  4. Vendors
  5. Style guide

1. Accessibility

Accessibility is our top priority. We aspire to:

  • explain our services and materials in clear, inclusive language
  • comply with and exceed provincial guidelines for website accessibility
  • provide clear instructions for how to access alternate formats and communication supports
  • partner with vendors that have recognized accessibility credentials

If you have an accessibility issue with the website, contact webrefresh@waterloo.ca and we will work to resolve it. The Accessibility Plan lays out our corporate commitment to accessibility.

2. Rights management

With the exception of photos or otherwise labelled materials, all content on the site is licensed with Creative Commons, Attribution-NoDerivs (CC BY-ND). This license allows for redistribution as long as it is passed along unchanged and in whole, with credit.

3. Website ownership

This site is owned and maintained by the communications division, part of the corporate services department. Visit our city staff page to learn more about our organizational structure.

4. Vendors

eSolutionsGroup provides the design and content management system for Waterloo.ca. We use SiteImprove to improve accessibility and digital certainty. When possible, we work with local photographers to acquire images.

5. Style guide

This guide communicates the rules we use to develop content for Waterloo.ca. It borrows from similar guides developed by Ontario.ca and Govt.nz.

Sections

Webpage types

Waterloo.ca uses different types of webpages to help users find information and complete tasks quickly.

Home page

Our home page is organized into different service areas called landing pages. It conveys the authority of a municipal website and prioritizes the most likely user actions above promotional or topical material.

Landing page

Landing pages cover broad service areas or topics. They have unique layouts and navigation items to help users find the most important information or services quickly.

Info pages

Info pages are the standard place for text content related to topics. These form the majority of Waterloo.ca’s webpages and will be where most editors make changes.

Considerations for creating a new info page:

  • how does creating the new page help the user?

  • what is the purpose?

  • can this content fit on an existing page?

Service pages

Service pages are used to apply, register or pay for a service, or intake information. They are created in FormBuilder or other associated applications such as the Building and Bylaw portal.

Tone

The overall tone of Waterloo.ca should be consistent across the website and optimized for what a user is trying to accomplish on a page. Our goal is to make things as simple and clear as possible for our users — to make it easier for people to get things done with government.

We write for a grade six to seven reading level and strive for a tone that’s:

  • friendly

  • simple

  • authoritative

  • helpful

Technical language

Explain complex ideas contained in projects or laws instead of quoting them directly. Include a hyperlink to the specific law, act or project document if applicable.

Avoid legal and technical language on Waterloo.ca and focus instead on describing the spirit, not the letter, of the law.

Active voice

We use active voiceinstead of passive voice, speaking directly to the person reading our content.

With active voice the subject of the sentence performs the action: Margaret [subject] sent [verb] the request. With passive voice the subject of the sentence receives the action: the request [subject] was sent [verb] by Margaret.

Speaking directly to users

Say 'you' and 'your' when talking directly to users. Simple contractions like 'you’re' or 'you’ll’ are acceptable.

Webpage organization

These rules cover how content is organized into different components of a page.

Page titles

A page title is a single phrase that describes content on the entire page. Use sentence case (only capitalize the first letter in the first word) for all page titles, unless the heading includes an official name.

Leads


Leads describe the purpose of the page in one or two short, plain language sentences. Use words and terms that people use when searching for a topic. Leads can also contain important elements that relate to the purpose of the page, such as links to a form or application.

Headings

A heading is a short phrase that describes the content directly following it.

Effective headings:

  • are short and scannable

  • omit non-essential words

  • put keywords first

  • are short and scannable

Use sentence case (only capitalize the first letter in the first word) for all headings, unless the heading includes an official name.

Content devices

This section covers how to use different content features to assemble easy-to-use webpages.

Sentences

Use short sentences with neutral, factual language, avoiding adverbs and adjectives unless necessary.

Paragraphs

Use short paragraphs with one to five sentences.

Callouts

Callouts are boxes in the page that highlight important text.

Effective callouts:

  • highlight information that is not part of the main content

  • deliver instructions or guidance about page content to readers

  • inform readers about important updates

  • are used sparingly to avoid losing the reader’s attention

Bullets

Use bulleted lists to list two or more pieces of information.
They are most effective when listing necessary information, such as eligibility requirements. When creating a bulleted list:

  • introduce the list with a lead-in sentence and a colon


  • use lower-case at the start of the bullet (unless the first word is an official name)

  • don’t use a comma or semicolon at the end of a bullet

  • don’t put “or” or “and” after a bullet

If the bulleted list follows a heading, or if the bullets consist of multiple sentences, use complete sentences for the bullets, capitalize first letters and include periods.

Avoid nested bullets — or sub-bullets — if possible. Treat nested bullets as a new set of bullets and follow the same rules as regular bulleted lists.

Numbered bullets

Use numbered bullets if you’re listing ordered information, such as instructions.

Buttons

Use a button on your page to feature a single user action, such as downloading a report or launching a form. If they feature an important component of content, place them as high up as possible.

Different colours are used for distinctive actions. Yellow is for a download or application, blue is for engagement opportunities:

 Yellow button example

Blue button example

Emphasis

Use emphasis to make an important user action stand out, such as an application date.

Bookmark links

A bookmark link helps user find the area of content on a webpage they are looking for.

PDFs and other file types

HTML (content in structured webpages) is the primary format on Waterloo.ca. Content should be published in HTML by default, and follow provincial accessibility standards for the web. More visual formats such as PDFs or jpegs can be published so long as their contents are already present in HTML.

When a PDF is published, link the document title and note the file type. For example:

FAQs


We don't use FAQs on waterloo.ca because research shows they make it harder for people to find information and can lead to duplication.


Grammar

These rules are designed to ensure consistency when writing for the web.

Abbreviations

Use language like “for example” or “such as” instead of “e.g.” or “i.e.”

Acronyms

Avoid acronyms if you don’t intend to use them again in the content.
 Acronyms are spelled without periods, unless they are part of the official name of an entity or a person’s name. Plural acronyms are marked with a lowercase ‘s’ with no apostrophe.

Addresses

Write out street names fully, such as 119 University Avenue West.

Capitals

Unnecesary capital letters make content more difficult to read. Use capitals only at the beginning of sentences, and in proper nouns and acronyms. A proper noun is the name of a particular person, place, organization or thing. Common nouns such as city, site plan, uptown and bylaw are not capitalized.

Use sentence case (only capitalize the first letter in the first word) for all headings and webpage titles, unless they include a proper noun.

Commas

Use commas to separate clauses in sentences and to separate items in a list. Don't use:

  • commas to mark the end of a bullet

  • Oxford commas (or serial commas)

Dashes

Hyphens (-) are used to join words together.

En-dashes (–) are used for ranges, conflicts or connections.

Em-dashes (—) are used like brackets or interruptions.

Dates

Use the format of Weekday, Month, Day, Year, such as Tuesday, January 1, 2017.
 Write out the day and month fully. 
If the day is not specified, a comma is not needed (for example, January 2017).
 If you’re referencing a season instead of a specific date, capitalize the season (for example, Winter 2017).

To indicate a date range, use to word 'to' instead of a dash or hyphen (for example, January 1 to 3),

Bold

If you want to emphasize an important phrase or sentence, use a boldface font. Do not use bold for headings.

Links and URLs

Always use descriptive links, such as learn more about property tax rates instead of the complete URL (such as https://waterloo.ca/en/government/tax-rates-and-relief-programs.aspx).


Do not hyperlink with terms that would be unavailable to users with accessibility challenges such as ‘click here’ or ‘view more.’

Money

Money is written in digits with a dollar sign in the front ($5). For service fees and costs, be as specific as needed. You can round budgets and other larger financial figures to the nearest dollar.

Naming conventions

When uploading files to the back end of the website, the file name is descriptive for an external audience. Do not use internal terms such as Corporate Services or council report numbers. If a page or project has multiple documents, name them with same prefix such as:

  1. Columbia Street West Environmental assessment

  2. Columbia Street West Final project plan

  3. Columbia Street West Zone change application

Avoid punctuation or extra spaces in the file name. Also ensure that the file name matches the document name in the file’s metadata. This can be changed using Adobe Acrobat by going to File > Properties.

Numbers

Spell out numbers under 10, and use digits for numbers 10 and above. For example, 15 people used nine pens in the workshop.

Spell out millions, billions and above. For example, five million people watched the video today, compared to 15 million yesterday.

For number ranges, such as ages, use digits only. For example, swimming lessons are offered for kids aged 3 to 12.

Periods

Use periods at the end of sentences, but not at the end of bullet points or lists.

Semicolons

Avoid using semicolons.

Time


Write time in numerical form, with the “a.m.” and “p.m.” suffixes separated from the numbers by a space and include the periods. To indicate a time range, use the word ’to’ instead of a dash.