Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

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

The following resources provide information about industry standards in technical communication and writing best practices. Use these references secondarily to the Splunk Style Guide.

Style guides

The Splunk Style Guide covers issues specific to Splunk docs, but standards for grammar, spelling, and style are extensively covered in technical documentation references as well as general writing guides.

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

Style issue Resource
Technical documentation style issues Google Developer Documentation Style Guide

https://developers.google.com/style

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

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

Writing references

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

Writing reference Publication date What's good about it
Every Page is Page One by Mark Baker and the Every Page is Page One website 2013 A resource with an accompanying blog, EPPO outlines the philosophy that the Splunk docs team subscribes to when architecting and developing information for Splunk customers.
Developing Quality Technical Information, IBM Press 2014 Best practices for developing docs in regard to accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness.
The Global English Style Guide: Writing Clear Translatable Documentation for a Global Market by John R. Kohl 2008 Guidelines for creating content that is ready for localization and translation.
Last modified on 23 September, 2019
PREVIOUS
UI text style guidelines
 

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


Was this documentation topic helpful?

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