Skip to main content

Links

When writing link text, it's best to use brief yet descriptive phrases that offer an idea of the content you're linking to.

Formats to structure link text​

To write practical link text, choose one of these formats:

  • Ensure that the text of the link matches precisely with the title or heading you are referring to, for example:

  • Write a description of the destination page to use as the link text, capitalized as if it's part of the sentence, for example:

    • 👍 You can Control your features and Make better decisions with data using Bucketeer solution.

Guidelines to write link text​

When writing link text, it is important to adhere to the following guidelines:

  • When you write a complete sentence that refers the reader to another topic, introduce the link with the phrase For more information, see or For more information about..., see. Check examples:

  • Write unique, descriptive link text that makes sense without the surrounding text. Don't use phrases such as this document, this article, or click here.

    👍 Recommended:

    For more information, see <a href="/tasks">How to open and manage tasks</a>

    ❌ Not recommended:

    Know more? <a href="/tasks">Click here.</a>.

    ❌ Not recommended:

    For more information, see <a href="/tasks">this article</a>.

  • Don't use a URL as link text. Instead, use the page title or a description of the page.

    👍 Recommended:

    For more information about protocols, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.html" class="external">HTTP/1.1 RFC</a>.

    ❌ Not recommended:

    See the HTTP/1.1 RFC at <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.html">http://www.w3.org/Protocols/rfc2616/rfc2616.html</a>.

  • To ensure that readers can quickly determine if a link is relevant, use descriptive link text that accurately describes the target page. Follow these tips for improving scanning content:

    • Whenever possible, use short link text. Avoid using long link text, like a sentence or paragraph.

    • Put important words at the beginning of your link text to make it more effective.

    • If a link downloads a file, write link text that indicates this action and the file type.

      👍 Recommended:

      <a href="/readme.txt">download the README.txt file</a>