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.


When writing about numbers that appear in a Splunk product UI, duplicate them exactly as the UI displays. Otherwise, follow these guidelines.

Duration of time

Always use a numeral for numbers associated with duration of time. See the following examples:

  • Change the default time range from 6 seconds to 60 seconds.
  • Authentication expires after 2 hours.
  • The instance remains active for 3 months.

When writing documentation, don't abbreviate units of time, such as seconds, hours, and months. You can abbreviate units of time in a Splunk product UI to save space. See Time in the UI text style guidelines.

Time of day

Always use a number for numbers associated with time of day. See the following example:

  • Office hours are from 6 AM to 5 PM.
  • The scheduled alert runs at 10 AM.

12-hour clock

Use 12-hour time. For full hours, don't include the minutes. Capitalize AM and PM without using punctuation, and precede the time period with a space. Review the following table for examples of correctly formatted time periods:

Do this Don't do this
6 AM 06:00 hours
2:30 PM 14:30 hours
Last modified on 11 January, 2024
Ranges   Versions

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