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

Dashes

Don't use dashes to format items in a list. Use a bulleted list.

Hyphen ( - )

Use a hyphen for compound adjectives that precede the noun they modify, and don't use a hyphen if the adjectives follow the noun they modify. Don't add spaces before or after the hyphen.

The following table shows where to place hyphens in compound adjectives:

Do this Don't do this
a case-sensitive username a case sensitive username
the password is case sensitive the password is case-sensitive

Em dash ( — )

Don't use em dashes in Splunk documentation. Keep your sentences short, and use either commas or 2 sentences to separate breaks in thought.

En dash ( – )

Don't use en dashes in Splunk documentation.

Last modified on 11 January, 2024
PREVIOUS
Comma
  NEXT
Exclamation points

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