When to avoid including an image

Avoid using images that replace explanations, unnecessary UI screenshots, photographs, or those containing customer or Splunk data in your documentation.

Avoid the following uses and types of images in your documentation:

  • Don't include an image to replace or avoid writing an explanation about how to complete a task.
  • Don't include a screenshot of the UI if the user can follow your written instructions without it. A well-designed UI doesn't need an accompanying screenshot in the documentation.
  • Don't use photographs in your docs.
  • Don't include an image if it contains customer data or Splunk data.