1. Home
  2. Docs
  3. Style Guide
  4. Links and References
  5. Hyperlinking Best Practices

Hyperlinking Best Practices

Hyperlinking connects the reader to related content, resources, or further information, facilitating a smooth reading experience. When using hyperlinks, it is important to ensure they are relevant, clearly labelled, and strategically placed to provide maximum value to the user.

Descriptive Link Text:

  • Use descriptive and meaningful link text: The link text should clearly indicate the destination or purpose of the link. Avoid vague phrases like “click here” or “read more.” Instead, use text that describes what the user will find upon clicking. Example: “Learn more about security best practices” instead of “Click here.”
  • Avoid using URLs as link text: URLs can be long and difficult to read, especially for non-technical users. Always use descriptive text instead of the raw URL. Example: “Visit our support page” instead of “https://www.example.com/support.”

Placement of Links:

  • Place links strategically within the text: Embed hyperlinks in the text where they are contextually relevant. This helps readers understand why the link is there and what to expect. Example: “For detailed instructions on setting up the application, see the installation guide.”
  • Avoid overlinking: Too many links in a paragraph can overwhelm readers and reduce the readability of the content. Only link to the most relevant and useful resources.

Accessibility Considerations:

  • Use accessible link text: Ensure that link text is easily understandable by screen readers. Avoid using generic phrases like “click here,” which do not provide context. Instead, use descriptive text that communicates the link’s purpose. Example: “See our privacy policy for more information.”
  • Provide tooltips or link titles when necessary: For links that require additional context, use the title attribute to provide extra information that appears when the user hovers over the link. 

Example: <a href=”#” title=”Download the latest version of the software”>Download the software</a>.

Opening Links:

  • Determine whether links should open in the same tab or a new tab: Links to content within the same site or document should open in the same tab to maintain context. External links to third-party sites may open in a new tab to prevent users from leaving the primary content. However, be cautious with this practice to avoid disrupting the user’s experience.

Dos:

  • Use descriptive text for hyperlinks: Example: “Read the API documentation for more details.”
  • Ensure links are accessible to every reader

Don’ts:

  • Don’t use vague link text like ‘click here’: This provides no context for the reader.
  • Avoid using URLs as link text: Instead, use descriptive, concise phrases.