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.

Colon

The following table shows ways to use a colon properly in your writing:

Scenario Example
To introduce bulleted lists, tables, or images. Always precede these elements with a full sentence. Use a full sentence and a colon to introduce the following items:
  • Bulleted lists
  • Tables
  • Images
To introduce a list within a sentence. Always precede the inline list with a full sentence. Capitalize the first word that follows the colon only when it's a complete sentence. The application can access the following items: the file system, the command line, and other applications.
To separate parts in a title or heading. Capitalize the first word that follows the colon.
  • Part 2: Edit the Collector configuration to add new components
  • Scenario: Kai monitors apps in a cloud environment
To separate a main idea from a secondary idea in a doc subheading or UI dashboard label. Capitalize the first word that follows the colon. Control your data volume: Aggregate your metrics

Sources contributing to false positive: Incorrect analytic logic

Last modified on 07 June, 2024
Brackets   Comma

This documentation applies to the following versions of Splunk® Style Guide: current, 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