Skip to main content

Hyperlinks

Last updated on
Open a doc issue   |   Edit this page

Creating engaging and user-friendly content extends beyond just the words you write; it also involves how you integrate hyperlinks. They should be informative and woven into your narrative, guiding readers to additional valuable resources.

Basic guidelines

  • Be Descriptive: Hyperlink text should accurately describe the linked content to provide users with clear expectations of where the link will take them.
  • Avoid Generic Text: Instead of using generic phrases like "click here" or "read more," use descriptive text that conveys the purpose or destination of the link.
  • Use Keywords: Incorporate relevant keywords in the hyperlink text to improve search engine optimization (SEO) and help users quickly identify the linked topic.
  • Keep it Concise: Aim for brevity in hyperlink text to maintain a clean and uncluttered appearance. Ideally, keep the text short while conveying the essential information.

Correct

Install the latest version of Docker.

See What is GitHub Cloud? for details.

For detailed guidance on engaging with us, see  Engage with your Enterprise DevOps Team.

Incorrect

Install the latest version of Docker here.

For more information about GitHub Cloud, go here.

In addition to the basic guidelines mentioned, avoid putting quotation marks around the link and ensure you use the exact title of the third-party document.

Correct

See the Virtual machines in Azure article in the Microsoft documentation.

Incorrect

See the "VMs in Azure" documentation here.