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:

  • Use a numeral when quantifying a unit of measurement or a rate.
  • Add a space between the numeral and the rate measurement.
  • Use the word "per" to describe a volume measurement.

Review the following table for examples of correctly formatted measurements:

Do this Don't do this
8 GB of memory 8GB of memory
An 8 CPU, 16 GB memory machine can achieve 50 to 60 Mb per second throughput. An 8 CPU, 16 GB memory machine can achieve 50 to 60 Mb/second throughput.

It's okay to abbreviate a unit of measurement in text. Ensure that you use the correct capitalization of the unit of measurement that you're referring to.

For example, use a capital "B" when referring to a multiple of the unit byte and a lowercase "b" when referring to a multiple of the unit bit. Review the following table for the correct capitalization of these units of measurement:

Unit Abbreviation
gigabit Gb
gigabyte GB
gigahertz GHz
kibibyte KiB
kilobit Kb
kilobyte KB
megabit Mb
megabyte MB
petabit Pb
petabyte PB
tebibyte TiB
terabit Tb
terabyte TB
Last modified on 11 January, 2024
Fractions   Phone numbers

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