Good linking provides access to related material without diverting the reader from the focus of the topic that they are in. If related topics in a chapter or manual add value to your content, consider linking to them in the topic.
Before adding links into your content, consider these best practices:
-
Don’t include links in the first paragraph of a topic.
-
Provide critical information in your topic, not in linked information.
-
Weigh any cost of including a link, such as distraction or confusion to the reader, against the benefits.
-
Provide context to the link so readers can decide whether they need to click.
-
Use the exact topic title or section heading, name of the page, or name of the entity you are linking to for the link text.
-
Use links in notes or cautions only if it helps the reader complete the task or aids their understanding of the note or caution content.