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.

Where to look if the Splunk Style Guide doesn't answer your question

The Splunk Style Guide covers issues specific to Splunk documentation, but standards for grammar, spelling, style, and content design are extensively covered in a number of other references.

If you can't find what you're looking for in the Splunk Style Guide, refer to these reference materials:

Writing standard Resource
Best practices for product and user interface text (Internal) Magnetic Design System

https://magnetic.cisco.com/0a43ab5cd/p/583e31-content-design

Grammar and punctuation for nontechnical terms The Chicago Manual of Style

http://www.chicagomanualofstyle.org/home.html

Spelling, definitions, and capitalization Merriam-Webster Dictionary

http://www.merriam-webster.com

Other technical documentation style issues Google Developer Documentation Style Guide

https://developers.google.com/style

Microsoft Style Guide
https://docs.microsoft.com/en-us/style-guide/welcome

Writing references

The following references can enhance your writing and understanding of best practices in a variety of technical communications:

Reference What's good about it
Every Page is Page One by Mark Baker and the Every Page is Page One website Every Page is Page One provides guidelines for technical writers to create standalone, user-centric documentation that doesn't rely on a traditional hierarchical structure.
Writing Is Designing: Words and the User Experience by Michael J. Metts and Andy Welfle Writing Is Designing offers suggestions for collaboration between writers and designers in an effort to create user-centered experiences when designing digital products.
Last modified on 24 April, 2025
Best practices for including videos  

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


Please expect delayed responses to documentation feedback while the team migrates content to a new system. We value your input and thank you for your patience as we work to provide you with an improved content experience!

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