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.


Don't use common abbreviations, such as a.k.a., e.g., etc., i.e., and vs. in documentation and UI text. Instead, use precise language and state what you mean. See the Usage dictionary for terms to use instead of abbreviations.

For keyboard shortcuts, abbreviate the names of keys only if you have a space constraint, otherwise spell out letter keys and key names. See Writing keyboard shortcuts in Splunk docs.

It's okay to abbreviate a unit of measurement in text. See Measurements.

Last modified on 08 December, 2023
Line breaks   Acronyms

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