Websites and URLs

General

  • When addressing a general audience, use the term address when referring to a website address. For a more technical audience, use URL instead.

  • When referring to specific sites in the documentation, don’t include https:// within the URL unless it’s something other than HTTP, such as FTP.

Examples
  • The trailing slash is optional and shouldn’t be used in a URL that ends with a file name.

  • Always write web and email addresses in lowercase.

  • When referring to a domain name in a paragraph, such as Coveo.com, omit http://www and capitalize only the first letter, even if the site name is capitalized differently. However, this rule doesn’t apply to technical instances, such as when you use a URL in an API call.

Grammar and formatting

  • Use the preposition "at" with the location of a specific address.

Example

Learn more about Coveo at www.coveo.com

  • Some might confuse the usage of a period at the end of a sentence to be part of the URL. In these instances, rewrite the sentence.

  • Avoid using click here, instead, use the title or a description of a page and link directly to it.

  • In alt text for a graphic that links to another location, state that the graphic is a link. Well-written alt text is important to your website’s accessibility and its Search Engine Optimisation (SEO).

Examples
  • (Alt text) Picture of an Administration Console that opens to the Admin UI.