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.

Bulleted lists

When you write Splunk documentation, use a bulleted list, sometimes called an unordered list, when the order of list items isn't important. For example, you can use a bulleted list for a list of options.

Qualities of bulleted lists

Bulleted lists must have the following qualities:

  • A complete lead-in sentence that describes the list's purpose, punctuated by a colon
  • A consistent hierarchy or order, such as alphabetization
  • More than 1 list item
  • No more than 1 sublist for each list item if needed, with at least 2 items in a sublist
  • Parallel sentence construction
  • Sentence case capitalization
  • 1 sentence or idea for each list item
  • End punctuation if the list items are complete sentences
  • No end punctuation if the list items are characters, words, or phrases

For more guidance on using lists, see Best practices for writing with lists.


The following example of a bulleted list contains a complete lead-in sentence. Each item in the list uses parallel construction and doesn't contain more than 1 phrase.

You can use the following types of Search Processing Language (SPL) commands:

  • Eventing commands
  • Generating commands
  • Reporting commands
  • Streaming commands
Last modified on 28 November, 2023
Best practices for writing with lists   Numbered lists

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