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


The following table shows ways to use a colon properly in your writing:

Scenario Example
To introduce unordered lists, tables, or images. Always precede lists, tables, and images with a full sentence. Use a full sentence and a colon to introduce the following items:
  • Unordered lists
  • Tables
  • Images
To introduce a list within a sentence. The application can access the following items: the file system, the command line, and other applications.
Last modified on 11 January, 2024

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