Splunk® Style Guide

Splunk Style Guide

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.


You can use an animated GIF to show steps in a UI. Use an animated GIF to supplement task information or paragraph text, so don't remove essential text in favor of a GIF.

If a GIF requires a voiceover, is longer than 5 seconds in duration, or needs the ability to pause or skip ahead, use a video instead. See Best practices for including videos.

See the following example of an animated GIF:

The following animation shows how to add a Flow Model and launch the Explorer. The animation starts from the home page. Then, the user clicks the Add new Flow Model button. A pop-up message appears, and the user enters a name and base search for the Flow Model and clicks submit. In the Flow Model editor, the user selects customer_id under correlation ID and action under step, and then clicks Explore. The Explore view shows a flowchart of steps, starting with "new account created" and ending in "purchased game".

For general guidelines on including images in Splunk docs, see Best practices for including images.

Last modified on 25 September, 2023
Diagrams   Inline images

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

Was this topic useful?

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