Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


The guidelines in the Splunk Style Guide establish best practices for writing technical documentation. Search docs.splunk.com to find documentation related to Splunk products.
Acrobat logo Download topic as PDF

See also section

A See also section is a section at the end of a topic that provides a list of links to related topics. When creating a See also section, use the heading "See also". Don't use "Learn more" or any other name.

When to include a See also section

Most Splunk documentation topics don't need a See also section, but a See also section can be beneficial for specific types of topics. For example, consider including a See also section for these types of content:

  • In a reference topic. For example, in a command reference topic, it's useful to include a See also section to point the reader to related commands.
  • In a use case topic. For example, if a topic provides a high-level use case, it might be useful to include a See also section with links to detailed information on how to perform the tasks described in the use case.
  • In a manual landing page. It's often useful to include a See also section in the first topic in a manual with links to information the user might be looking for.

When not to include a See also section

Don't include a See also section in the following circumstances:

  • In a conceptual or task topic.
  • If the links are a laundry list of related topics. Don't include links to other topics on the basis that they are about the same feature.
  • If you can place the link in the same paragraph as the relevant content.
  • In a topic that has a Next step section.

For guidance on linking in Splunk documentation, see Best practices for including links.

Last modified on 30 June, 2020
 

This documentation applies to the following versions of Splunk® Style Guide: current


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters