search

WeAreSnook / human-services

Extensions proposed by the English Local Government Association (LGA) and the local government OpenCommunity project to the OpenReferral standard for human services data. Schema generator code is given to express the schema in various formats. Data conversion routines to make it conform to the standard. API that serves the data in a format compliant with the standard.
0 stars 1 forks source link

Make sure urls are clear and conform to gov/accessibility standards #87

Open ailsaleen opened 3 years ago

ailsaleen commented 3 years ago

  1. Open Referral URLs are designed to be naturally user (and SEO) friendly, and to follow a consistent, predictable, format. These guidelines set out how URLs should be constructed, and our approach to setting up additional URLs for marketing purposes.

  2. These standards apply to openreferraluk.org and its sub-domains.

    openreferraluk.org URL style

  3. The style for openreferraluk.org URLs is that: a) URLs always need to be clear, unambiguous, easy to read, easy to type and easy to share

    b) all URLs must be in lower case

    c) URLs must use words and should not contain acronyms, wherever possible

    d) dashes should be used to separate words within URLs so they are easy to read - for example, https://openreferraluk.org/about-open-referral

    e) articles (a, an, the) and other superfluous words should not be used. For example, use /documentation-tools rather than /docs-and-guides

    f) URLs should use the verb stem, where possible. For example, /register instead of /registering

    g) each page must have a URL which is as short, memorable and unambiguous as possible, especially if a URL is going to be referred to offline

    h) URLs should be based on user need rather than the (current) name of a policy, scheme or service, which might change.

ailsaleen commented 3 years ago

fyi @annhelen and @UsmanAfzal made a new ticket here for Sprint 6 for URLs

annhelen commented 3 years ago

Here's the table for URLs which I've shared with @yemijaiyeola and @kingdomlevel URLs table

Hi Yemi and Niall - please note I've updated 'documentation-and-tools' to 'documentation-tools' after feedback from Usman. Many thanks

UsmanAfzal commented 3 years ago

Also 'contact-us' to 'contact'

Thanks

annhelen commented 3 years ago

Hi Usman - (left you a note on slack) after double checking, 'contact-us' is fine and widely used on GOV.UK.

annhelen commented 3 years ago

I also think it would be preferable to use 'documentation-and-tools', as not having the 'and' slightly changes the meaning. GDS says to avoid articles (a, an, etc) but 'and' is not an article and I've seen it used. I'm not overly attached to this though.

UsmanAfzal commented 3 years ago

Many examples of 'and' removed in the primary navigation of the website, let's keep this one out.

Screenshot 2021-04-19 at 13 58 50 Screenshot 2021-04-19 at 13 58 37 Screenshot 2021-04-19 at 13 58 15 Screenshot 2021-04-19 at 13 57 31 Screenshot 2021-04-19 at 13 57 17 Screenshot 2021-04-19 at 13 57 04
annhelen commented 3 years ago

In response to tree testing results we've decided to amend 'documentation-and-tools' to 'developers' (so the top menu heading will be 'For developers'). So that resolves the debate anyway :-) I've updated the url table @yemijaiyeola @kingdomlevel

annhelen commented 3 years ago

Updated spreadsheet for URLS

Thanks for updating those URLs so quickly @kingdomlevel! Much appreciated. A couple of other changes (if you could take a look when you have the opportunity):

  1. update '/about-open-referral' to '/about-standard' (avoids rep of 'open-referral')
  2. URLS should not have trailing slash marks as it goes against gov.uk standards (penultimate bullet point )