cds-snc / notification-planning

Project planning for GC Notify Team
4 stars 0 forks source link

Content audit : Documentation site - Client libraries #173

Open YedidaZalik opened 2 years ago

YedidaZalik commented 2 years ago

Things to review and consider

Are the images and grids accessible?

Is "clients" sufficiently descriptive in page title https://documentation.notification.canada.ca/en/clients.html?

It looks like the audience for this section is only developers. If so, could we indicate that near the start of the page? If not, can we revise this page for plain language? If not, can we define all the abbreviations?

Potential fix We cannot design a potential fix until the team decides the audience for and purpose of this content. Reconsider this page once team provides direction.

image

amazingphilippe commented 2 years ago

Page titles for the documentation site follow this pattern:

Page title | GC Notify

Instead of simply "GC Notify" we could instead use "GC Notify API documentation"