Including images in Splunk docs
Images enhance technical documentation by clarifying complex processes or concepts. They must supplement, not replace, written content and include alt text for accessibility.
Images enhance technical documentation when the product UI or workflow that you're describing is complex or difficult to understand. Don't use images to replace textual content.
Before you include an image in your documentation, review Best practices for including images.
You can use the following types of images in Splunk docs:
| Type of image | What it's for |
|---|---|
| Screenshots | To show a complicated UI workflow or help a new user visualize the product. |
| Diagrams | To help users understand complex system architecture, task flows, processes, and conceptual information. |
| GIFs | To show multiple steps in a task sequence. |
| Inline images | To identify a UI element, such as a toolbar icon or a button. |