Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Types of images

Splunk docs include the following types of images:

  • Screenshots
  • Diagrams
  • GIFs
  • Inline images

Images can help clarify your writing, but they must never replace your content. See Best practices for including images before including an image in your content.

Screenshots

You can use a screenshot to help users understand complicated UI workflows. Screenshots can be especially useful in content that is primarily task information, such as tutorials and use cases, and in content for audiences who are new to the product. Screenshots are less useful in concept, reference, or troubleshooting information.

When you include a screenshot in your content, be sure to capture the UI while using the light theme with your screen zoomed to 100%.

This example shows a screenshot of the full width of the UI and its surrounding text:

When the package is uploaded successfully, it appears in the table on the Uploaded Apps page, shown in the following image. The app name and version appear only when the package passes all AppInspect checks and is approved.

The Uploaded Apps view lists several private apps and shows the different possible statuses of those apps: approved, installed, rejected, vetting, and app validation failed to complete.

Diagrams

You can use a diagram to help users understand complex system architecture, task flows, processes, and conceptual information. Diagrams supplement your content, so don't replace your writing with a diagram. It's okay if a diagram has text in it.

See the following example of a simple diagram:

This diagram shows a standard two-phase search process. The process is described before the diagram, in the section "Overview of parallel reduce search processing".

See the following example of a complex diagram:

The Splunk Phantom web interface connects to a load balancer, which connects to three Splunk Phantom cluster nodes. The nodes connect to a PostgreSQL database, a file share, and a Splunk platform deployment.

This complex diagram uses color but doesn't rely on color to convey meaning. The lines use color in combination with different dash lengths so that readers who can't distinguish between colors can follow the path of the lines. A legend is included to identify each type of line.

GIFs

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.

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".

Inline images

You can use an inline image in a sentence to label a UI element, such as a toolbar icon or a button.

See the following example of an inline image:

Click the settings icon (Settings) to show a list of settings.
Last modified on 02 November, 2021
PREVIOUS
Best practices for including images
  NEXT
Best practices for including links

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