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 links in notes or cautions only if it helps the reader complete the task or aids their understanding of the note or caution content.
Use these best practices to make docs accessible for all audiences. For additional guidance on making docs more accessible using links, see Write docs for everyone.
Types of images
Links for Splexicon entries and download files
This documentation applies to the following versions of Splunk® Style Guide: current