When to include an image

Images enhance understanding by illustrating complex workflows, orienting users to intricate screens, and supplementing text with visual aids, especially when processes or interfaces are not intuitive.

Consider using an image in the following circumstances:

  • A workflow is difficult or complicated to process by words alone.

  • You need to orient users to a screen that has many functional parts.Y

  • ou need to illustrate complex relationships among discrete parts of a product.

  • You need to diagram or illustrate conceptual information.

  • You need to illustrate several steps in a complex or intricate process.

  • The UI requires complex interactions.

  • The design of the UI or workflow isn't intuitive and you think users might need extra help.

  • You need to supplement the name of a UI element in text with a visual aid from the UI.

Before you create an image

Before you create an image, follow these approaches:

  • Consider whether you can use a table or list to convey information instead of a screenshot or diagram. For example, you can display forms, search results, or parts of a process in a table.
  • Understand that the information you capture in an image might change in a future release. Consider whether you're able to update the image every time the UI or process changes as well as maintain the image for every release.
  • Whenever possible, reuse an existing image instead of creating a new one. Consider whether you can use the same image for multiple steps or procedures.
  • When you create a screenshot, capture the UI while using the light theme with your screen zoomed to 100%. If possible, don't capture the UI using the dark theme.
  • When you use a screenshot from the UI, check that the image doesn't show sensitive information, like customer data or Splunk data.

After you create an image

After you place an image in your documentation, complete the following tasks:

  1. Introduce each image with a full sentence that describes its contents.
  2. You can include an optional title with an image. Do not include enumeration because the numbers lose context if an image is reused.
  3. Always include alt text with an image.

    For more information on making images accessible in Splunk docs, see Using images with accessibility.

  4. Make sure your images are accurate and up to date before release.