Usage dictionary
Use and avoid certain terms when writing Splunk documentation.
The following list outlines terms to use and avoid in Splunk documentation.
*
*nix
Use to refer to both UNIX and Linux together. If only 1 system is supported, use "UNIX" or "Linux". See *nix in the Splexicon.
A
abnormal
Don't use. Use "atypical" or "not typical" instead.
abort
Don't use unless referring to a specific command or system language.
Otherwise, use "force quit", "cancel", "fail", "close", "stop", "end", or another term that accurately reflects the situation.
above
Don't use to refer to a location in a document. Directional or visual instructions are unhelpful to visually impaired users. Use "earlier" or "previous" to refer to page elements.
For versions of software, use "higher".
ad hoc
Use only when referring to an unscheduled search. Otherwise, don't use Latin abbreviations or terms. See ad hoc search in the Splexicon.
Don't use any other term for a search that a user launches manually. For references not about an unscheduled search, use "if needed".
add-on
Use "add-on" when writing about a Technical Add-on, Supported Add-on, or Domain Add-on in Splunk docs. See add-on in the Splexicon.
Include a hyphen and a definite article. The plural form is "add-ons". You can write it as "the add-on" after the first instance of the full name of the add-on.
|
|
admin, administrator
In most cases, use "admin" as an adjective to identify the role-based access control label. Use "administrator" as a noun to identify a user's job title or responsibility.
Don't capitalize either term.
|
|
after
Use to denote a chronological sequence of events that doesn't rely on cause and effect.
Don't use to mean "when".
| After you install the update, save your changes. | After a user logs in to your organization, a SessionLog event is created. |
allow, allow entry, allow list, allow rule
Use "allow" as a verb and "allow list" as a noun. For a single item, use "allow rule" or "allow entry".
allows you to
Avoid this phrase. Focus on the goals a user can achieve with their product rather than what the product lets a user do.
AM
Write with capital letters and without periods. Use to mean between midnight and 11:59 in the morning when writing the time of day.
and/or
Don't use. Pick the word that best fits the sentence.
and the reverse
Use instead of "vice versa" or "vice-versa".
anti
Don't include a hyphen.
| antivirus | anti-virus |
app
Use to refer to an application that runs on the Splunk platform. See app in the Splexicon.
appears
Use instead of "shows up".
approved
Use instead of "vetted".
are
Use instead of "have been".
at present
Don't use. Use "now" instead.
at this point
Don't use.
atypical
Use instead of "abnormal".
auto
Don't include a hyphen.
|
|
B
back end, back-end
Use "back end" as a noun. Use "back-end" as an adjective.
Don't use if you can find a more specific term, such as server, operating system, database, network, and the like.
backend
Don't use. Use "back end" as a noun and "back-end" as an adjective.
base directories
Put the variable name for a directory in all capital letters regardless of the operating system. If the variable name has spaces, replace the spaces with the underscore ( _ ) character.
For *nix, precede the base directory with a dollar sign ( $ ). For Windows, surround the base directory with percent signs ( % ).
| *nix | Windows |
|---|---|
$SPLUNK_HOME |
%SPLUNK_HOME% |
below
Don't use to refer to a location in a document. Directional or visual instructions are unhelpful to visually impaired users. For page elements, use "following", "later", or "next".
For versions of software, use "lower".
blacklist
Don't use. Use "deny list" as a noun and "deny" as a verb. There are additional synonyms you can use in specific situations:
-
"Deny" refers to access.
-
"Reject" refers to validity.
-
"Exclude" refers to inclusion.
For IP traffic, for example, "deny" is suitable. For files or rules, "exclude" might be more specific.
|
|
Boolean
Use to describe a logical operator that takes 1 of 2 values, generally True and False.
Always capitalize.
bulletproof
Don't use. Use "safe", "secure", or another unambiguous term.
by using
Use instead of "via".
C
can
Use to mean ability instead of "have the option to" or "is able to".
can't, cannot
Use as 1 word instead of "can not".
can not
Don't use as 2 words.
capability
A user action within the Splunk platform. Use this term to refer to Splunk role-based access controls (RBAC). See capability in the Splexicon. Don't use to refer to the functionality or features of a product.
| Each role contains at least 1 capability. Capabilities define what users who hold a certain role can do. | The latest release of Splunk Enterprise Security has the following new capabilities. |
case sensitive, case-sensitive
Don't include a hyphen when you write the term after the noun that it modifies. Include a hyphen when you write the term before the noun that it modifies.
|
|
check
When used to mean verify, use instead of "double-check".
You can also use "check" in the context of selecting a check box.
check box
Use as 2 words. To describe the action of using the check box, use "check or uncheck a check box", or "select or deselect a check box".
check out
Don't use. Use "see".
Classic Experience
Use to mean the validated architecture of Splunk Cloud Platform. Always capitalize. Don't include the definite article and don't use "Classic" on its own. Use with the preposition "on" when describing how to use an Experience or its components. Always refer to "Experience" in the same sentence when describing the designation.
|
|
clear
Use instead of "purge". Alternatively, use "delete" or "remove".
click
Don't use. Use "select". Avoid terms that are specific to certain devices and input methods.
choose
Don't use when referring to UI selections. Use "select".
comma separated, comma-separated
Don't include a hyphen when you write the term after the noun that it modifies. Include a hyphen when you write the term before the noun that it modifies.
|
|
command line, command-line
Use "command line" as a noun. Use "command-line" as an adjective.
|
|
.conf file
Use lowercase letters prefaced with a period ( . ) or spell out "configuration file". See configuration file in the Splexicon.
|
|
configured
Use instead of "preconfigured".
could
Don't use. Use "can" or write the sentence in the imperative mood. Avoid the subjunctive mood.
| Start by setting up a new stanza in the transforms.conf file. | You could start by setting up a new stanza in transforms.conf. |
D
DA
Don't use Domain Add-on or the abbreviation DA when you write about the product.
It's okay to use "DA" if it's used in a file or path.
dark mode
Don't use. Use "dark theme" instead.
dark theme
Use lowercase letters when writing generally about the color contrast choice that a user can select for their UI. Don't use "dark mode". Follow the capitalization used in the UI.
|
|
data
Use as a singular mass noun. Write "data is" rather than "data are", and use "less data" rather than "fewer data". Don't use "datum".
|
|
data model, datamodel
Use "data model" when referring to a knowledge object. Use "datamodel" when used as a search command.
See data model in the Splexicon.
data point
Use as 2 words.
database
Use as 1 word.
dataset
Use as 1 word. See dataset in the Splexicon.
datum
Don't use. Use "data" instead.
default
Use instead of "out-of-the-box".
delete
Use instead of "purge". Alternatively, use "clear" or "remove".
demonstrate
Don't use. Use "show" instead.
deny, deny list
Use instead of "blacklist". Use "deny" as a verb and "deny list" as a noun.
deploy
Use to mean the process of setting up the components for a partial or entire system, which can include installing and configuring software and hardware. Use "install" to mean installing a piece of software.
|
|
desire
Don't use. Use "want" instead.
| Edit the stanzas to collect the data you want to view. | Edit the stanzas to collect the data you desire. |
dialog box
Don't spell as "dialogue box". Use "dialog box" instead of "modal" or "pop-up" when referring to the UI control.
|
|
dialogue
Use "dialogue" when referring to a conversation. Use "dialog box" when referring to the UI control.
directory
Use when discussing file system structures in a CLI context or when addressing developers who work with file structures programmatically. For CLI contexts, don't use "folder", which is typically used in GUI contexts.
| Use the ./splunk add command and specify a directory for data ingestion to configure network inputs. | Use the ./splunk add command and specify a folder for data ingestion to configure network inputs. |
disable, disabled, disables
Don't use. Choose a plain-language alternative that describes the action or state. For example:
-
Deactivate, deactivated, deactivates
-
Deselect, deselected, deselects
-
Hide, hidden, hides
-
Inactive
-
Turn off, turned off, turns off
-
Unavailable, makes unavailable
double-check
Don't use. Use "check" or "make sure" instead.
do not
Use as 2 words when the emphasis is on "not". Otherwise, it's okay to use "don't".
domestic
Avoid using "domestic" to refer to the United States. Use a more specific reference, like "in the US".
drag-and-drop
Use as an adjective. For a verb, use "drag", which implies drop.
drill down, drilldown
Use "drill down" as a verb. Use "drilldown" as a noun, adjective, or interactive functionality. Don't use "drill-down". See drilldown in the Splexicon.
drop-down
Use as an adjective. Include a noun, such as "menu" or "list", after "drop-down".
dummy data
Don't use. Use "placeholder data" instead.
E
earlier
Don't use to refer to versions of software. Use "lower".
It's okay to use "earlier" to refer to parts of documentation or page elements that precede a user's current location, such as "See <link to section> earlier in this topic". If appropriate, you can also use "previous".
e.g.
Don't use Latin abbreviations or terms. Use "for example" instead.
either/or
Don't use. Pick the word that best fits the sentence.
enable, enabled, enables
Don't use to show the counteraction of turning off a feature, deactivating a feature, or describing a deactivated feature.
Choose a logical plain-language alternative that explains the action or state. For example:
-
Activate, activated, activates
-
Select, selected, selects
-
Show, shows
-
Turn on, turned on, turns on
enable again
Use instead of "re-enable".
enables you to
Avoid this phrase. Focus on the goals a user can achieve with their product rather than what the product lets a user do.
endpoint
Use as 1 word.
enter
Use as a verb to refer to inputting text. Don't use "specify". Don't use "type" because there are multiple ways to enter text.
|
|
enter again
Use instead of "re-enter".
epoch time
Don't use. Use "UNIX time" instead.
etc.
Don't use Latin abbreviations or terms. Be specific and concrete when you write. Use "and so on" instead.
ex.
Don't use common abbreviations in place of precise language. Use "for example" instead.
execute
Don't use. Use "run" instead.
exempt
Use instead of "grandfathered".
Experience
Use to refer to a named Experience such as Victoria Experience or Classic Experience. Always capitalize. Don't include a definite article. Use with the preposition "on" when describing how to use an Experience or its components.
|
|
F
fail over, failover
Use as 2 words when written as a verb. Use as 1 word when written as a noun or adjective.
fatal
Don't use. Use "unrecoverable" or choose another unambiguous term.
feature
A piece of code shipped with a product that provides a tool a user can use to complete a task or action. Generally, this term is best used in release notes to describe updates to a product release. Avoid documenting features and instead put the emphasis on how a user can achieve their goal.
Don't use to refer to the capabilities or functionality of a product.
| Version 5.1.0 of the add-on contains the following new features. | Version 5.1.0 of the add-on contains the following new capabilities. |
fetch
Don't use. Use "retrieve" instead.
field-value pair
Include a hyphen between "field" and "value" when they modify the word "pair".
|
|
file name
Use as 2 words. Don't use "filename".
file name extensions
The suffix appended to a specific file. Put in lowercase letters.
|
|
file path
A path that describes a location in a file system structure. Use as 2 words. Don't use "filepath". When writing out file paths, use a forward slash ( / ) for *nix and a backslash ( \ ) for Windows. List both the *nix and Windows file paths, in that order.
Use angle brackets to indicate parts of a file path that differ by user or operating system, such as /home/<username>/.login.
| *nix | Windows |
|---|---|
| $SPLUNK_HOME/bin/splunkd | %SPLUNK_HOME%\bin\splunkd.exe |
file system
Use as 2 words. Don't use "filesystem".
file type
Use "file type" to describe a broad file category, such as a Portable Document Format (PDF) document or Graphics Interchange Format (GIF) file. It's okay to shorten the file type as an abbreviation.
Capitalize the abbreviation when it's used as an adjective or when it stands alone in text. An exception to the standard styling for file types is for configuration files (.conf files) which are styled like a file name extension.
|
|
filename
Don't use. Use "file name" instead.
filepath
Don't use. Use "file path" instead.
filesystem
Don't use. Use "file system" instead.
first-class entity
Don't use. Use "top-level entity" instead.
flesh-colored
Don't use terminology that assumes race to describe color. Use the most accurate word to describe the color.
folder
Use when referring to file system structures in a GUI context. For GUI contexts, don't use "directory", which is typically used in CLI contexts.
| Remove the existing Splunk_TA_Windows folder from $SPLUNK_HOME/etc/shcluster/apps. | Remove the existing Splunk_TA_Windows directory from $SPLUNK_HOME/etc/shcluster/apps. |
following
Use to refer to parts of documentation or page elements that immediately come after a user's current location, such as "in the following section" or "in the following table".
If appropriate, you can also use "later" and "next".
for example
Use instead of "e.g.", "ex.", or "for instance".
for instance
Don't use. Use "for example" instead.
foreign
Avoid "foreign" when referring to a location outside the United States. Use a more specific reference, like "outside the US".
freezes
Use instead of "hangs".
front end, front-end
Use "front end" when written as a noun. Use "front-end" when written as an adjective. Don't use if you can find a more specific term, such as the name of the product, feature, app, and the like.
functionality
Use this term to describe how Splunk product features work. Don't use to refer to the capabilities or features of a product.
| The following update provides new functionality in the custom visualizations framework. | Dashboards are a functionality of Splunk Cloud Platform. |
G
grandfathered
Don't use. Use "exempt" instead.
guided setup
Use "wizard" only if you need to refer to a UI component label containing the word "wizard".
H
hang, hangs
Don't use. Use "stops responding" or "freezes" instead.
hard-code, hard-coded, hard-coding
Use only for a technical or developer audience when referring to coding values and functions directly into the source code rather than obtaining values from general input or external sources.
Include a hyphen in all uses of the term.
hard-to-find
Use instead of "needle-in-a-haystack".
have been
Don't use. Use "are" instead.
have knowledge of
Don't use. Use "know" instead.
have the option to
Don't use. Use "can" instead.
he, him, his
Don't use in documentation. Use "they", "them", their", "a user", "the users", or another inclusive term.
hex
Don't use. Use "hexadecimal" instead.
higher
Use instead of "later" to refer to versions of software.
hit
Don't use. Use "select", "enter", or another device-agnostic term.
home page
Use instead of "homepage".
host name
Use instead of "hostname".
homepage
Don't use. Use "home page" instead.
hostname
Don't use. Use "host name" instead.
hover over
Use instead of "point to" or "mouse over" to describe the action of positioning the pointer over a UI item.
hung
Don't use. Use "stops responding" or "freezes" instead.
I
i.e.
Don't use Latin abbreviations or terms. Use "in other words" instead.
if
Use to indicate a hypothetical situation, a possibility, or a condition that must be met for a particular action, behavior, or event to occur. Don't use "when" if the situation is hypothetical.
| If the search returns too many results, try refining your search. | When the search returns too many results, try refining your search. |
if needed
Use instead of "ad hoc".
if you want to
Don't use in a task step. Use "(Optional)" to indicate the step is optional.
illegal characters
Don't use. Use "invalid characters" instead.
in other words
Use instead of "i.e.".
include
Use as a verb instead of "whitelist".
install
Use as a verb, not as a noun. Use to mean installing a piece of software. Use "deploy" to describe the process of setting up the components for a partial or entire system, which can include installing and configuring software and hardware.
|
|
instance
Use to refer to a Splunk Enterprise instance. Use the full phrase "Splunk Enterprise instance" at the first use in the topic or section.
internet
Lowercase, unless it is the first word in a sentence or part of a proper noun, such as Internet Explorer. Always use with a definite article, such as "the internet".
into
Use as 1 word in the context of getting data into a Splunk product.
| Get data into Splunk User Behavior Analytics. | Get data in to Splunk User Behavior Analytics. |
invalid characters
Use instead of "illegal characters".
is able to
Don't use. Use "can" instead.
it is recommended
Don't use. Rewrite to make a statement about what the customer must do.
J
JSON
Use as a modifier, not as a standalone term. Choose the most precise noun based on the context.
|
|
just
Don't use.
K
kill
Use only when referring to the *nix command or process. Otherwise, use "quit", "stop", or "end" based on the situation.
key-value pair
Include a hyphen. Don't use a slash or space. Don't use the phrase "key value" on its own.
|
|
keyboard characters
The core section of keys on a keyboard. Special keyboard characters, such as the at symbol ( @ ), pipe ( | ), and forward slash ( / ) , aren't standardized on international keyboards.
Be explicit when referring to special keyboard characters.
know
Use instead of "have knowledge of".
L
later
Don't use to refer to versions of software. Use "higher".
It's okay to use "later", "following", or "next" to refer to parts of documentation or page elements that follow a user's current location, such as "See <link to section> later in this topic".
latest
Use to refer to the latest versions of browsers and SaaS.
launch
It's okay to use "launch" to match a UI. Otherwise, use "open" instead.
|
|
left
Don't use to refer to a location in a document. Use temporal language, such as "earlier", "previous", "following", "next", or "later".
Directional or visual instructions are unhelpful to visually impaired users, and locations of elements can change depending on the device being used to read the content.
lets you
Avoid this phrase. Focus on the goals a user can achieve with their product rather than what the product lets a user do.
leverage
Don't use. Use "use" instead.
light mode
Don't use. Use "light theme" instead.
light theme
Use lowercase letters when writing generally about the color contrast choice that a user can select for their UI. Follow the capitalization used in the UI when writing about a button or other component in the Splunk product UI.
|
|
line break
Use to refer to the point where a line of text ends and a new line starts. Use as 2 words without a hyphen. Don't refer to a forced line break as a "carriage return".
Linux
Use "Linux" if only Linux is supported. Write "*nix" when referring to both Linux and UNIX.
log in
Use "log in" as a verb. Use "log in to" to describe entering a username or password for a system. Use "log in as" to describe entering with a specific role or privileges. Don't use "log on", "sign in", or "sign on".
To use as a noun or adjective, use "login" instead.
|
|
log off
Don't use. Use "log out" instead.
log on
Don't use. Use "log in" instead.
log out
Use as a verb. Don't use "log off".
login
Use "login" as a noun or adjective. Don't use "logon". To use as a verb, use "log in" instead.
|
|
logoff
Don't use. Use "log out" instead.
logon
Don't use. Use "log in" instead.
long press
If there are multiple ways a user can interact with a touch-based interface, use an input-agnostic term such as "select and hold" instead of "long press".
If you must specify the user's gesture in order to perform an action on a mobile device, you can use "long press".
look up
Use "look up" as a verb. To use as a noun or adjective, use "lookup".
| Set the CSV lookup to look up the host. | Set the CSV lookup to lookup the host. |
lookup
Use "lookup" as a noun, adjective, or knowledge object. To use as a verb, use "look up".
See lookup in the Splexicon.
lower
Use to refer to versions of software. Don't use "earlier".
M
machine
Use to refer to the virtual or physical machine that the instance runs on.
main branch
Use instead of "master branch".
make sure
Use instead of "double-check".
manager
Use instead of "master".
mankind
Don't use. Use "all", "everyone", "humanity", "humankind", or another inclusive term.
master
Don't use. Use "manager" for the centralized management, leading, or coordinating node, and when you discuss the relationship of that node with other nodes that interact with it. See manager node in the Splexicon.
|
|
master branch
Don't use. Use "main branch" instead.
may
Use only to mean permission. Use "might" for possibility or "can" for ability.
metadata
Use as a singular mass noun. Write "metadata is" rather than "metadata are".
|
|
might
Use to mean possibility.
modal
Don't use. Use "dialog box" instead.
more
Use when referring to an icon with 3 horizontal dots ( ) or 3 vertical dots (
) in a Splunk GUI. Don't capitalize. Include an inline image of the icon when possible.
|
|
mouse over
Don't use. Use "hover over" instead.
multi
Don't include a hyphen in words that begin with the prefix "multi".
|
|
multivalue field
Use instead of "multivalued field". See multivalue field in the Splexicon.
multivalued field
Don't use. Use "multivalue field" instead.
N
n/a
Write in lowercase letters. Use only in tables or lists to refer to a value that is not applicable or not available. Spell out instead of abbreviating when used in paragraph text.
|
|
needle-in-a-haystack
Don't use. Use "hard-to-find" instead.
| Troubleshoot a hard-to-find case by searching for a specific trace. | Troubleshoot a needle-in-a-haystack case by searching for a specific trace. |
next
Use to refer to parts of documentation or page elements that immediately follow a user's current location in a topic, such as "in the next section".
If appropriate, you can also use "following" and "later".
non
Don't include a hyphen.
| nonzero | non-zero |
not typical
Use instead of "abnormal".
note that
Don't use in text. Consider whether using a note admonition is more effective.
now
Use instead of "at present".
null
Write in lowercase letters to refer to an empty value, the null Search Processing Language (SPL) command, or when null appears in SPL search results.
O
on prem, on-prem, on premise, on-premise
Don't use. Use "on-premises" instead.
on-premises
Include a hyphen and treat "premises" as plural. Use instead of "on premise", "on-premise", "on prem", or "on-prem".
|
|
once
Use when you mean 1 time and no more. Don't use to mean "after" or "when".
only
Place immediately before or after the word or phrase it modifies.
The sdselect command supports only the required arguments for the tonumber() and tostring() functions. |
The sdselect command only supports the required arguments for the tonumber() and tostring() functions. |
open
Use instead of "takes you to" or "launch".
out-of-the-box
Don't use. Use "default" or "prepackaged" instead.
P
patch
Don't use. Use "update".
path
Use instead of "path name" or "pathname".
path name, pathname
Don't use. Use "path" instead.
percent
Use a numeral followed by the percent sign ( % ) to specify an exact percentage. Don't use the word "percent".
|
|
peer
Use instead of "slave".
percentage
Use as a noun when not specifying an exact quantity.
perform
Don't use in the context of searches or other commands. Use "run" instead.
pinch
If there are multiple ways a user can interact with a touch-based interface, use an input-agnostic term such as "zoom out" instead of "pinch".
If you must specify the user's gesture in order to perform an action on a mobile device, you can use "pinch".
placeholder data
Use instead of "dummy data".
please
Don't use.
plug in, plugin
Use "plug in" as a verb. Use "plugin" as a noun or adjective. Don't use "plug-in".
plug-in
PM
Write with capital letters and without periods. Use to mean between noon and 11:59 in the evening when writing the time of day.
point to
Don't use. Use "hover over" instead.
pop-up
Don't use. Use "dialog box" instead.
preconfigured
Don't use. Use "configured" instead.
premium apps
Don't use. Use the name of the app instead or describe the apps in another way.
Premium Solutions
Don't use. Use the name of the app instead or describe the apps in another way.
prepackaged
Use instead of "out-of-the-box".
press
Don't use. Use "select" for the action of keying in characters on a keyboard or activating a button.
previous
Use to refer to parts of documentation or page elements that immediately precede a user's current location, such as "in the previous section". If appropriate, you can also use "earlier".
punch
Don't use. Use "enter" instead.
purge
Don't use. Use "delete", "clear", or "remove" instead.
Q
query
Use when referring to a SQL command or a database. To refer to a Splunk search, use "search" instead of "query".
|
|
quite
Don't use.
R
radio button
Use to refer to the UI element. Don't use "radio" as a noun when referring to a radio button.
read-only
Include a hyphen. Use as an adjective.
|
|
read/write, read/write/delete
Use the forward slash instead of a hyphen when you write about read, write, and delete permissions.
|
|
real time, real-time
Use "real time" when used as a noun. Use "real-time" when used as an adjective.
|
|
realtime
Don't use. Use "real time" instead.
really
Don't use.
reboot
Use "reboot" only when it's part of a command. In most cases, use "restart" instead.
recommend
Don't use. Rewrite to state what the customer must do.
reenable
Use instead of "re-enable". Alternatively, use "enable again".
re-enable
Don't use. Use "reenable" or "enable again" instead.
reenter
Use instead of "re-enter". Alternatively, rewrite as "enter again".
re-enter
Don't use. Use "reenter" or "enter again" instead.
regex
Don't use. Use "regular expression" instead.
regular expression
Use instead of "regex".
remove
Use instead of "purge". Alternatively, use "clear" or "delete".
rerun
Use instead of "re-run". Alternatively, use "run again".
re-run
Don't use. Use "rerun" or "run again" instead.
restart
Use instead of "reboot".
retrieve
Use instead of "fetch".
review
Use instead of "sanity check".
right
Don't use to refer to a location in a document. Use temporal language, such as "earlier", "previous", "following", "next", or "later".
Directional or visual instructions are unhelpful to visually impaired users, and locations of elements can change depending on the device being used to read the content.
run
Use in the context of searches or other commands. Don't use "execute" or "perform".
|
|
run again
Use as an alternative option to "rerun". Use "again" only if it is necessary for clarity.
runtime
Use as a noun or adjective. Don't use "run time" or "run-time".
|
|
S
(s), (es)
Don't write a lowercase "s" or "es" in parentheses after a noun to indicate both singular and plural.
Choose the best option for your sentence. In most cases, using the plural works best for understanding.
SA
Don't use Supporting Add-on or the abbreviation "SA" when you write about the product. Use "add-on" instead.
It's okay to use "SA" in a file or path.
safe
Use instead of "bulletproof". Alternatively, use "secure".
sanity check
Don't use. Use "review" or "verification" instead.
scroll
Don't use. Use "read" or another device-agnostic verb that describes the intended action.
search
Use instead of "query" to refer to a Splunk search. See search in the Splexicon.
|
|
secure
Use instead of "bulletproof". Alternatively, use "safe".
see
Use instead of "check out" for references and cross-references. To describe the UI, use "view" instead.
| For an introduction to forwarders, see About forwarding and receiving data. | Check out About forwarding and receiving data. |
select
Use to highlight text, choose menu items, go to a link, push a button, open a tab, check a check box, or interact with a keyboard. Don't use "specify", "click", or "press".
|
|
select and hold
Use this term to cover the multiple ways a user can interact with a touch-based interface.
If you must specify the user's gesture in order to perform an action on a mobile device, you can use "long press".
server
Because the term "server" is used in the IT industry to refer both to a type of software and the machine that the software runs on, avoid this term. Be clear when you refer to the Splunk platform.
Use "instance" in the Splunk platform context and "machine" for the virtual or physical machine the instance runs on.
she, her, hers
Don't use in documentation. Use "they", "them", their", "a user", "the users", or another inclusive term.
should
Don't use. Avoid the subjunctive mood, and use imperative or indicative mood instead.
|
|
show
Use instead of "demonstrate" to mean illustrating or explaining with examples.
shows up
Don't use. Use "appears" instead.
sign in, sign on
Don't use. Use "log in" instead.
simply
Don't use.
slave
Don't use. Use "peer" for nodes that interact with the centralized management, leading, or coordinating node.
|
|
source type, sourcetype
Use "sourcetype" when referring to the field name. Use "source type" in all other instances. See source type in the Splexicon.
space-separated
Include a hyphen when used as an adjective.
| A space-separated list | A space separated list |
sparkle icon, AI sparkle icon
Use "sparkle icon" or "AI sparkle icon" to refer to the icon for an AI assistant in a Splunk GUI ( ). Don't use "starburst icon", and don't capitalize. Include an inline image of the icon when possible.
|
|
specify
Don't use in task steps. Use "select" or "enter" instead.
specifically
Don't use.
spin down, spin up
Don't use. Use "stop" and "start", or use the most descriptive action for the virtual machine.
Splunk
When used alone, use "Splunk" to refer only to the company, not to any product. Don't use in the possessive form.
|
|
Splunk Cloud Platform
Use as a proper noun to refer to the software, spelled with initial capital letters. Don't include a definite article, use as a possessive, or shorten the name using an acronym or abbreviation.
|
|
Splunk Developer Portal
Use as a proper noun to refer to https://dev.splunk.com, spelled with initial capital letters and using a definite article. Don't use abbreviations or acronyms in place of this term. Don't confuse this term with the Splunk Developer Program.
|
|
Splunk Developer Program
Don't use in documentation. This term refers to the program containing developer offerings like services, tooling, and the Splunk Developer Portal.
Don't confuse this term with the Splunk Developer Portal itself, which refers to https://dev.splunk.com.
Splunk Enterprise
Use as a proper noun to refer to the software, spelled with initial capital letters. Don't include a definite article or use as a possessive.
|
|
Splunk Observability Cloud
Use to refer to the product suite. Don't omit "Splunk" or use an acronym to shorten the name. Don't include a definite article or use as a possessive. Don't refer to the suite as a platform.
|
|
the Splunk platform
Use to refer to both Splunk Cloud Platform and Splunk Enterprise. Don't capitalize "platform" or use as a possessive. Include a definite article in most cases. Use as a modifier when writing about an instance, a deployment, or an environment when you're describing multiple platform products.
|
|
starburst icon
Don't use to refer to the icon for an AI assistant in a Splunk GUI ( ). Use "sparkle icon" or "AI sparkle icon" instead.
Splunk software
Use to refer to any combination of Splunk Enterprise, Splunk Cloud Platform, any Splunk-supported apps and add-ons, and any other software produced by Splunk. Don't capitalize "software" or use it as a possessive.
|
|
Splunk Support Portal
Use to refer to the portal where customers with a support contract can get assistance from Splunk Customer Support.
Capitalize the initial letters.
Splunk UI
Use only in reference to the product called Splunk UI. For all other cases, use "Splunk Web".
Splunk Web
Use to refer to the graphical user interface for the Splunk platform. See Splunk Web in the Splexicon.
|
|
splunkd
Use when referring specifically to the Splunk Enterprise process, the service that is installed with Splunk Enterprise on Windows machines, or a service used to manage the splunkd process on Linux machines. Don't use in place of Splunk Enterprise or the Splunk platform. See splunkd in the Splexicon.
|
|
spread
If there are multiple ways a user can interact with a touch-based interface, use an input-agnostic term such as "zoom in" instead of "spread".
If you must specify the user's gesture in order to perform an action on a mobile device, you can use "spread".
SSH
Use as a noun. Don't use as a verb.
|
|
stack
Use only in specific cases where the word "stack" is used, like in the name of a CLI command or an API. Don't use to refer to a Splunk Cloud Platform deployment.
| Use the add-stack command to configure a Splunk Cloud Platform deployment. | Splunk Cloud Platform stack |
standalone
Write as 1 word with no hyphen. Use this term only as an adjective. Don't use "stand alone" or "stand-alone".
|
|
start
Use instead of "spin up".
stop
Use instead of "spin down".
stops responding
Use instead of "hangs".
suicide mode
Don't use. Use "time until restart" or choose another unambiguous term.
switch, switch component
Use as a noun to describe the moveable slider bar in the UI that switches between on and off states.
It's okay to say "switch", "switch component", "toggle", or "toggle switch".
sync, synchronize
Use instead of "synch".
synch
Don't use. Use "sync" or "synchronize" instead.
T
TA
Don't use Technology Add-on or the abbreviation "TA" when you write about the product. Use "add-on" instead.
It's okay to use "TA" in a file or path.
takes you to
Don't use. Use "open" instead.
tap
If there are multiple ways a user can interact with a touch-based interface, use an input-agnostic term such as "select" instead of "tap".
If you must specify the user's gesture in order to perform an action on a mobile device, you can use "tap".
tarball
Don't use. Use "TAR file" instead.
TAR file
Use instead of "tarball".
The purpose of this document is..., This document describes..., This topic describes...
Don't use. Rewrite to be user-focused.
through
Use instead of "via".
thus
Don't use.
timeseries
Don't use. Use "time series" as a noun or "time-series" as an adjective.
time series, time-series
in the Splexicon.
time until restart
Use instead of "suicide mode".
toggle, toggle switch
Use as a verb to describe moving a switch component between on and off states. Use as a noun to describe the moveable slider bar in the UI that switches between on and off states.
It's okay to also call it a "switch", "switch component", or "toggle switch".
top-level entity
Use instead of "first-class entity".
type
Don't use to describe user input. Avoid terms that are specific to certain devices and input methods. Use "enter" instead.
U
UNIX
Use "UNIX" if only UNIX is supported. Write "*nix" when referring to both UNIX and Linux.
UNIX time
Use instead of "epoch time".
unrecoverable
Use instead of "fatal".
update
Use instead of "patch".
upsert
Don't use. Instead, clarify the action.
| Inserts rows if the rows don't exist, or update rows if they do exist | Upsert |
URI, URL
Use "URI" or "URL" instead of "URN" when referring to the respective string type. Choose the most specific initialism for your scenario.
URN
Don't use. Use "URI" instead.
use
Use instead of "leverage" or "utilize".
user base
Use as 2 words instead of "userbase".
userbase
Don't use. Use "user base" instead.
username, user name
Use "username" in written text.
If "user name" appears as 2 words in the UI, write "user name" as 2 words in the documentation to match.
utilize
Don't use. Use "use" instead.
V
v
Don't use. Spell out "version" instead of abbreviating with a "v".
| Splunk platform versions 6.6.x and 7.0.x | Splunk platform v6.6.x, v7.0.x |
verification
Use instead of "sanity check".
version
Use instead of "v" to indicate the software version.
versus
Use instead of "vs.".
Alternatively, use "or", "as opposed to", or another appropriate term.
very
Don't use.
vetted
Don't use. Use "approved" instead.
via
Don't use Latin abbreviations or terms. Use "by using" or "through" instead.
vice versa, vice-versa
Don't use Latin abbreviations or terms. Use "and the reverse" instead.
Victoria Experience
Use to refer to the validated architecture of Splunk Cloud Platform. Always capitalize. Don't include the definite article and don't use "Victoria" on its own.
Use with the preposition "on" when describing how to use an Experience or its components. Always refer to "Experience" in the same sentence when describing the designation.
|
|
view
Use instead of "see" to describe the UI.
|
|
visit
Don't use in the context of websites. Use "go to", "navigate to", or another phrase.
vs.
Don't use. Use "versus" or another phrase instead.
W
want
Use instead of "desire" or "wish" to show hope for or to express a need.
web
Lowercase unless it is part of a proper name, like Splunk Web or World Wide Web.
when
Use to indicate an action, behavior, or event that is expected or certain to occur. This term implies a cause-and-effect relationship.
|
|
whether
Use instead of "whether or not".
whether or not
Don't use. Use "whether" instead.
whitelist
Don't use. Use "allow list" as a noun and "allow" or "include" as a verb. For a single item, use "allow rule" or "allow entry".
There are additional synonyms you can use in specific situations. "Allow" refers to access, "accept" refers to validity, and "include" refers to inclusion. For IP traffic, for example, "allow" is suitable. For files or rules, "include" might be more specific.
| Set up an allow list to include specific incoming data. | Whitelist the specific incoming data. |
wildcarded
Don't use. Use "wildcard" with an asterisk in parentheses after the term to denote the search action of matching characters in string values.
| You can use a wildcard ( * ) to match noninternal indexes in searches. | Indexes in searches can be wildcarded, although * matches only noninternal indexes. |
wish
Don't use. Use "want" instead.
wizard
Avoid using this term. Use only if you need to refer to the UI component and the label contains the word "wizard". If you must refer to the general component, use "guided setup" sparingly. Always aim to describe the user's actions and goals instead of the components and features of the product.
|
|
would
Don't use. Avoid subjunctive mood. Write in the indicative or imperative mood instead.
| The example shows a type of script you can create for your deployment. | The example shows a type of script you would create for your deployment. |
X
x (HTTP status codes)
Use a lowercase "x" to represent a range of HTTP status codes.
|
|
x (version number in releases)
Use a lowercase "x" at the relevant place in the version number when referring to maintenance builds, minor versions, or releases for a product. Don't include a "v" before the number.
|
|