Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF


Follow the capitalization guidelines in The Chicago Manual of Style. Some capitalization guidelines are specific to Splunk documentation:

Capitalization for emphasis

Don't capitalize all letters in a word to show emphasis.

Doc components

For the following components in Splunk docs, use the capitalization guidelines in the following table. See Capitalization style definitions for nuances in the different styles.

Doc component Capitalization style
Manual titles Headline style
Chapter titles Sentence style
Headings at any level, including headings in tables Sentence style
List items Sentence style
Column headings in a table Sentence style
UI text See UI text style guidelines.

Splunk product names, features, and components

Capitalize Splunk product names. In general, don't capitalize the names of features or components.

For correct capitalization of Splunk terms, see the Splexicon.

For capitalization of the parts of a Splunk product architecture, such as a heavy forwarder or a search head, see Splunk product terminology.

For capitalization within a Splunk product UI, such as whether to capitalize a button label or dialog box title, see the Capitalization section in the UI text style guidelines.

Concepts versus UI terms

Don't capitalize terms that are normally capitalized as UI terms when they refer to concepts instead. See the following examples:

Concept UI term
Users with admin privileges can change the server settings. Select Settings > Server Settings.
Identify the number of indexers in your deployment. Select Data > Indexers.
Create a custom deep dive to investigate the root cause of a specific issue in your IT environment. From the ITSI main menu, select Deep Dives.

Capitalization style definitions

The types of capitalization styles referenced are as follows:

Headline style
Capitalize the first and last words, nouns, pronouns, verbs, adjectives, adverbs, and subordinating conjunctions (if, because, as, that, and so on).
Don't capitalize articles (a, an, the), coordinating conjunctions (and, but, or, nor), the "to" in an infinitive, and prepositions (with, to, for, in, from).
For hyphenated words, capitalize the first element and the subsequent elements unless they are articles, prepositions, and coordinating conjunctions. The following are examples:
  • Cross-Selling Opportunities
  • The Command-Line Interface
Sentence style
Capitalize the first word and all proper nouns, such as product names.
Last modified on 11 April, 2023
Use device-agnostic language
Formatting reference

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