Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Avoid anthropomorphisms

Anthropomorphism is attributing human characteristics to inanimate objects. Computers don't think, want, worry, or do other things that are uniquely human. Avoid anthropomorphisms in your writing.

Correct
The forwarder sends data to the location that you set in the configuration file.
Processing components process the data.
Incorrect
The configuration file tells the forwarder where to send the data.
Processing components handle the data.
Last modified on 05 March, 2020
PREVIOUS
Write in indicative or imperative mood
  NEXT
Write accessible documentation

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