Splunk Style Guide

Splunk Style Guide

Download manual as PDF

Download topic as PDF

Example names and domains

If you need to create a fictitious name, email address, domain name, phone number, or IP address in your docs, create an example that adheres to the following guidance.

Names

If you need a fictitious name for an example in your docs, use a name that's sensitive to culture, religious affiliation, holidays, traditions, politics, and business. Make sure that the name you create reflects the wide range of names used around the world.

Don't use a fictional character that's currently in copyright, your own name, or the name of friends or family members as an example name.

See the following examples of names that meet this guidance:

  • Alex Martin
  • Claudia Garcia
  • David Mayer
  • Maria Dubois
  • Rutherford Sullivan
  • Vanya Patel
  • Wei Zhang

Email addresses

If you need a fictitious email address for an example in your docs, use a name that follows the guidance in the Names section. Never use your own name, or the name of friends or family members, in an example email address.

Use Buttercup Games, a fictitious online store created by Splunk, as the email domain.

See the following examples:

  • info@buttercupgames.com
  • alex@buttercupgames.com
  • buttercup@buttercupgames.com
  • claudia@buttercupgames.com
  • david@buttercupgames.com
  • maria@buttercupgames.com
  • rutherford@buttercupgames.com
  • vanya@buttercupgames.com
  • wei@buttercupgames.com

In cases where it doesn't make sense to use Buttercup Games as the email domain, use the @example.com suffix.

Domain names

If you need a fictitious domain name for an example in your docs, use http://www.example.splunk.com.

In cases where it doesn't make sense to use Splunk in the URL, use http://www.example.com. The Internet Assigned Numbers Authority (IANA) set aside this domain specifically for documentation needs.

Phone numbers

If you need a fictitious phone number for an example in your docs, use a North American phone number in the range +1-800-555-0000 through +1-800-555-9999. The North America Numbering Plan set aside this range of phone numbers to use in examples and in fiction.

Never use a real phone number as a phone number example.

IP addresses

If you need a fictitious IP address for an example in your docs, use one of the IP addresses in the following ranges:

  • 192.0.2.0 to 192.0.2.255
  • 198.51.100.0 to 198.51.100.255
  • 203.0.113.0 to 203.0.113.255

The Internet Engineering Task Force (IETF) set aside this block of addresses specifically for documentation needs.

Last modified on 24 July, 2020
PREVIOUS
Contractions
  NEXT
Plurals in parentheses

This documentation applies to the following versions of Splunk Style Guide: current, current


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

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