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.

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.

Ensure the text surrounding the diagram sufficiently captures the purpose and meaning you want to convey in the image. 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:

Alerts are passed from Splunk Enterprise and Splunk Cloud Platform in the form of saved searches, data models, and notable events. The alerts move either by CEF mapping fields or from CIM translation to Splunk App for SOAR. The events get passed to Splunk Phantom and Splunk SOAR.

This complex diagram uses color but doesn't rely on color to convey meaning. The lines use different colors, patterns, and arrows to differentiate the elements. The arrows are labeled so readers can follow the lines.

For guidelines on when to include and avoid using images, see Including images in Splunk docs.

Last modified on 11 July, 2025
Screenshots   GIFs

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

Acrobat logo Download manual
Acrobat logo Download this page

Please expect delayed responses to documentation feedback while the team migrates content to a new system. We value your input and thank you for your patience as we work to provide you with an improved content experience!

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