Terminology and word usage in the UI
Ensure consistent terminology and word usage across products and documentation by consulting resources on usage, terminology, abbreviations, voice, tone, and bias-free language.
Use terms consistently across UI text in the product and content in help documentation. See the following resources for guidance on word usage, product terminology, abbreviations, voice and tone, and more:
| Topic | Link |
|---|---|
| Terms to use and avoid | Usage dictionary |
| Product terminology | |
| Splunk-specific terminology definitions | Splexicon |
| Abbreviations | Abbreviations, acronyms, initialisms |
| Punctuation | Punctuation and symbols |
| Voice and tone | |
| Bias-free language |
Product abbreviations
Some Splunk products have approved abbreviations that you can use, such as Splunk IT Service Intelligence (ITSI) and Splunk Enterprise Security (ES). Do not use abbreviations if they aren't approved. Refer to your product's specific style sheet to find what abbreviations you can use.
Follow these guidelines for using product abbreviations:
- Strive to use the full product name when possible. Don't use an abbreviation to save space if it sacrifices clarity.
- In long-form text, such as in a guided setup or tooltip, define the abbreviation at first use.
- If the product name appears multiple times in the same component or screen and you choose to abbreviate the name, use the abbreviation consistently after defining it.
- In instances where it might not make sense to define the abbreviation or if space is a major concern, such as in a field label or as part of a table, use the approved product abbreviation alone. Avoid this situation when possible.
Note: If you're not sure whether to use an abbreviation, contact your legal liaison and the Information Architecture team.