Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Acronyms

Always spell out a full term at first use on every page before you refer to it as an acronym or initialism. Use your best judgment for commonly accepted abbreviations, such as REST and API.

Add the acronym or initialism in parentheses after the full name.

Correct
Use the Splunk Search Processing Language (SPL) to search your data.
Incorrect
Use SPL (the Splunk Search Processing Language) to search your data.

Capitalize all letters in an acronym or initialism, including specific file name extensions and file types that are used as adjectives. See "File name extensions" and "File types" in the Usage dictionary.

Don't use periods with acronyms or initialisms when they stand alone in text.

Correct
CSV file
HTTP protocol
JSON file
Upload the docs.pdf attachment.
Incorrect
c.s.v. file
http protocol
json file
Upload the docs.PDF attachment.

Don't use an acronym if it doesn't closely match the words it refers to.

Avoid
When using a tool like Volume Shadow Copy Services (VSS)...
Use
When using a tool like Volume Shadow Copy Services...

See Measurements for abbreviating rates of measurement.

See Dates and Time for date and time abbreviations.

Last modified on 21 November, 2019
PREVIOUS
Abbreviations
  NEXT
Contractions

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