Common acronyms and initialisms

Ensure acronyms and initialisms are spelled out at first use, capitalized, and match their full terms. Use abbreviations without definitions if widely recognized.

Consider your audience's level of understanding and use your best judgment for commonly accepted abbreviations, such as REST and API. If an industry or common term is recognized most often by its abbreviation, you can use the abbreviation without defining it.

Spell out acronyms and initialisms at first use

In general, when using an acronym or initialism, follow these guidelines:

  • Always spell out a full term at first use on every page before you refer to it as an acronym or initialism. If the acronym or initialism doesn't match the full term, don't use it.
  • Add the acronym or initialism in parentheses after the full name.
  • Capitalize the acronym or initialism. See more details in Capitalize common acronyms and initialisms.
  • Use the same acronyms and initialisms consistently after defining them on the page.
  • Use acronyms and initialisms for product names only if they are approved. See Acronyms and initialisms for product names.
    Note: If you're not sure whether to use an abbreviation, contact your legal liaison and the Information Architecture team.

The following table shows an example of introducing an initialism at first use:

"" Do this "" Don't do this
Use the Splunk Search Processing Language (SPL) to search your data. Use SPL (the Splunk Search Processing Language) to search your data.

Capitalize common acronyms and abbreviations

Capitalize all letters in an acronym or initialism, including file name extensions and file types that you use as adjectives. Don't use periods with acronyms or initialisms when they stand alone in text.

See the following table for examples:

"" Do this "" Don't do this
CSV file c.s.v. file
HTTP protocol http protocol
JSON file json file
Upload the docs.pdf attachment. Upload the docs.PDF attachment.

See more examples in file name extensions and file types in the Usage dictionary.

Ensure acronyms and initialisms match their spelled-out versions

Don't use an acronym or initialism if it doesn't closely match the words it refers to. See the following table for examples:

"" Do this "" Don't do this
Use a tool like Volume Shadow Copy Services. Use a tool like Volume Shadow Copy Services (VSS).