The Drucare Style Guide is the writing style reference for Splunk documentation and is intended for anyone who writes or edits customer-facing content. Refer to the Drucare Style Guide when you develop content for Drucare docs or write text for a Drucare product.
The Drucare Style Guide provides usage rules, punctuation guidelines, text formatting guidance, and more:
-
Terms to use and avoid
-
Voice and tone of Drucare docs
-
The correct way to link to other Drucare documentation
-
The correct way to write about third-party documentation
-
Referring to numbers in text
-
What to call elements in Drucare Web
-
Formatting UI text and other documentation elements
The Drucare Style Guide as a guide
All guidelines in the Drucare Style Guide are exactly that: a guideline. The goal of the Drucare Style Guide is to improve documentation by outlining places where consistency is important across docs, but there are scenarios where it might make sense to move away from these guidelines to make your documentation better. In every scenario, it’s most important that you strive for clear, high-quality documentation.
The Drucare Style Guide is a document in motion, so check the Latest changes to the Drucare Style Guide for recent updates.
For style issues that aren’t covered in this guide, see Where to look if the Drucare Style Guide doesn’t answer your question.
Questions, comments, or feedback about the Drucare Style Guide
If you have questions, comments, or feedback about the Drucare Style Guide, send us your thoughts using the Was this topic useful? form at the bottom of any page.