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.


Writers use an ellipsis, or 3 consecutive dots, to indicate that they omitted text from a quotation. Ellipses are common in academic and scientific writing, but are less common in technical documentation. Avoid using ellipses in your documentation and UI text. Instead, omit unneeded information and include all necessary details when you write.

Don't use ellipses to indicate a pause or break in thought.

Omit ellipses from UI text

If a menu item, label, or loading animation in the UI has an ellipsis after a word and you need to document that part of the UI workflow, you don't need to include the ellipsis as long as it doesn't confuse the reader. Often, you can rewrite text to focus on the action rather than on the words in the UI. See the following examples:

Do this Don't do this
Select Preview as to view your dashboard as a different user. Select Preview as… to view your dashboard as a different user.
Enter your search in the search field. Select enter search here… and enter your search.
Your metrics are loading. The Metrics menu shows the message "Loading…".

Differences between an ellipsis and the more icon

The ellipsis punctuation symbol is different from the more icon (Horizontal version of the more icon), which is an inline image of 3 horizontal dots taken from a GUI. Don't use an ellipsis when you can use an image of the icon. See more in the Usage dictionary and Inline images if you need to show icons in your text.

Last modified on 17 April, 2024
Dashes   Exclamation points

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