Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Be active and present

Strive for active voice and present tense in your documentation. Writing in active voice allows readers to place themselves as the subject in the documentation, and present tense tells readers what they can expect as they work through the topics.

While there are times using passive voice and future tense is appropriate, always keep your audience in mind and center your writing around the user as much as possible.

Active voice

Active voice makes content clear by indicating who or what performs the action, even when the subject is implied. Minimize the use of passive voice in your writing.

Correct
Click Print to print the document.
The forwarder sends data to the receiver.
Incorrect
When the Print button is clicked, the document is printed.
Data is sent to the receiver.

Present tense

Present tense allows readers to experience the documentation while they read it. Minimize the use of past tense or future tense in your writing.

Correct
The summary statistics continue to calculate allowed items, but the items don't appear in the dashboard.
All apps are processed through the tool before they are published to Splunkbase.
Incorrect
The summary statistics will continue to calculate allowed items, but they will not be displayed in the dashboard.
All apps will now be processed through the tool before being published to Splunkbase.
Last modified on 09 June, 2020
PREVIOUS
Use plain language
  NEXT
Write in indicative or imperative mood

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