Splunk® Style Guide

Splunk Style Guide

The guidelines in the Splunk Style Guide establish best practices for writing technical documentation. Search docs.splunk.com to find documentation related to Splunk products.

Screenshots

You can use a screenshot to help users understand complicated UI workflows. Screenshots can be especially useful in content that is primarily task information, such as tutorials and scenarios, and in content for audiences who are new to the product. Screenshots are less useful in concept, reference, or troubleshooting information.

When you include a screenshot in your content, be sure to capture the UI while using the light theme with your screen zoomed to 100%.

This example shows a screenshot of the full width of the UI and its surrounding text:

When the package is uploaded successfully, it appears in the table on the Uploaded Apps page, shown in the following image. The app name and version appear only when the package passes all AppInspect checks and is approved.

The Uploaded Apps view lists several private apps and shows the different possible statuses of those apps: approved, installed, rejected, vetting, and app validation failed to complete.

For general guidelines on including images in Splunk docs, see Best practices for including images.

Last modified on 25 September, 2023
Including images in Splunk docs   Diagrams

This documentation applies to the following versions of Splunk® Style Guide: current

Acrobat logo Download manual
Acrobat logo Download this page

Was this topic useful?







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