Skip to content

2 Documentation Templates

ShannonTucker edited this page Feb 15, 2022 · 1 revision

Below is a sample of the component documentation to help Design System users where to find specification information.

Component name

Summary of the purpose of the component.

Overview

This section provides images of the different variations and states of each component.

Usage

When to use the component

Guidance on when to use the component or if the pattern follows the Canada.ca pattern guidance a link will be provided.

When NOT to use the component

Guidance on when NOT to use the component or if the pattern follows the Canada.ca pattern guidance a link will be provided.

How to use the component

Guidance on how to use the component or if the pattern follows the Canada.ca pattern guidance a link will be provided.

Customizing the component

This section highlights the customizations that can be made and/or any limitations to customizing the component.

Related components

In this section you will find links to any components that are closely related to help you decide which one to use.

Accessibility

Any accessibility requirements will be highlighted in this section.

Samples

This section displays samples of the component in use.

How we created this component- 4A Assessment

This section explains the results of our 4A Assessment and explains any design changes we made to alter, augment or add.


Below is the styles documentation template.

Styles

Overview

Usage

When to use the component

Guidance on when to use the component or if the pattern follows the Canada.ca pattern guidance a link will be provided.

When NOT to use the component

Guidance on when NOT to use the component or if the pattern follows the Canada.ca pattern guidance a link will be provided.

How to use the component

Guidance on how to use the component or if the pattern follows the Canada.ca pattern guidance a link will be provided.

Customizing the component

This section highlights the customizations that can be made and/or any limitations to customizing the component.

Accessibility

Any accessibility requirements will be highlighted in this section.

4A Assessment

This section explains the results of our 4A Assessment and explains any design changes we made to alter, augment or add.

Clone this wiki locally