Anchors and "Jump to" sections in knowledge base articles


Introduction

Not many articles would require or need anchors with a "Jump to" section. These would generally be decided on a case-by-case basis. For instance, a lengthy article with multiple subsections that would need to remain as a single article could make use of this features.

This guide assumes that you have an understanding of how to create anchors and "Jump to" links. If not, please consult your favorite search engine on the web.

Explanation

Anchors

Anchors should be placed at the beginning of the line of the section name. They show up in the editor as a tiny bookmark icon, and they do not add extra spacing. Name the anchors using short versions of their section names.

An anchor should be used at the beginning of the "Jump to" section, with "Back to top" links at the end of every section. The "Back to top" anchor should be named "top."

"Jump to" sections

A "Jump to" section should be created just before the instructions begin.

Never put a "Jump to" link for the top section.

If there are two sections in your article, you only need one "Jump to" link. In this case, put the link on the same line as the words "Jump to".

EXAMPLE:

Jump to: B: Connect using iPhone or iPad

If there are three or more sections, use a bullet list with all but the first sections, and use the appropriate subtitle numbering scheme.

EXAMPLE:

Jump to:

  • B: Connect using macOS
  • C: Connect using Windows