Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF

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.
Acrobat logo Download topic as PDF


Use an apostrophe when writing contractions and making names possessive. Don't use an apostrophe to make product names, company names, or trademarked terms possessive or plural.

When to use an apostrophe

You can use an apostrophe to write a contraction:

  • Let's
  • Don't
  • Can't

You can use an apostrophe for possessive nouns that are not product names, company names, or trademarked terms:

  • The user's credentials
  • The organization's users
  • The app's home page

When not to use an apostrophe

Don't use an apostrophe to make a product name, company name, or trademarked term possessive. See also Possessive names and terms. The following table shows examples of proper apostrophe use:

Do this Don't do this
The dashboard shows data pulled from Splunk Enterprise's internal log files. The dashboard shows data pulled from the Splunk Enterprise internal log files.
Submit a case using Splunk's Support Portal. Submit a case using the Splunk Support Portal.
Search's capabilities are robust. The search function has robust capabilities.
Last modified on 11 January, 2024

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