Support your content
Ensure the success of your app or add-on by including documentation, a contact form, and monitoring Splunk Answers for questions about your content.
Document your content
You can make your product documentation available inline on the product listing page on Splunkbase, or you can provide this content on your own site. Provide both step-by step and conceptual documentation on how to get the most out of your product.
- Know your audience. Who are the intended users of your product? What do you expect a user of your product to know before starting? Do you expect your users to know how to write a regular expression or a Splunk search? Do they need to know statistics or networking concepts? State the prerequisites for successful use of your product.
- Include explicit, detailed steps and examples of how to use your product.
- Provide links out to other material if needed. Link to topics in the Splunk product documentation to provide context or deeper background on topics relating to using your product.
- Use clear, simple language whenever possible. Users of your product may not be native English speakers.
Suggested documentation structure
- Table of contents: A table of contents allows your users to see what information is available and access different sections easily.
- Introduction: Include a brief description of the goals and features of your product.
- Prerequisites: List any content that your product needs to function correctly. List any specific hardware or licensing requirements that your product needs. Explain any technologies or concepts that your users need.
- Architecture: Describe the structure of your product. If your product contains many components and/or is to be installed on different Splunk components (such as forwarders, deployment servers, indexers, search heads, etc), then a diagram is especially helpful. You can upload images if you are hosting your documentation on Splunkbase.
- Installation: Provide detailed, sequence-ordered steps for installing your product. If required, explain any specific commands.
- Use cases: Explain how to use your product to reach the goals you state in your introduction. If possible, provide a separate section for each unique use case, with detailed instructions for achieving the desired outcome.
- Upgrade instructions: If you can upgrade this version release of your product from a previous version, provide detailed instructions on how to do so, as well as any relevant changes in structure or operation your existing users should expect.
- Reference material: If your product includes lookup tables, saved searches, scripted inputs, or other similar knowledge objects, it's useful to provide details about them so your users know what's included and how to use them in your product. You can list them in detail, or describe where to find them within your product's file structure.
Provide contact information
Use the email address of your Splunk user account to submit your content. The address of the submitting Splunk user will also receive a notification when a user posts a question to Splunk Answers and tags it with your content's special tag. Try to respond to customer queries in a timely fashion.
Follow your content on Splunk Answers
Creating this tag requires using the name of your content. You can change the name later by editing your content, and the text in this special tag will automatically update to reflect any changes.
When a user posts a question about your app or add-on to Splunk Answers, they can use the special tag on their question to make sure you see their question. The email associated with the user you were logged in as when you submitted the content for posting on Splunkbase will receive an email whenever someone uses this tag on a question on Answers.
Options for submitting content
App support types
This documentation applies to the following versions of Splunk® Answers and Splunkbase: splunkbase