Writing your Start Guide
What is a start guide?
Customers will only see this section after installing your app, so the guide should focus on getting set up and getting started, not on installing the app.
Your start guide is the section of your listing in the Intercom App Store where customers learn how to set up and use your app after installing it. Use this space to help your customers get the most value out of your app.
How to submit the start guide
You can write and submit the start guide in the associated section of your Developer Hub. You can save it as a draft and update it at any point before you submit your app for a review. Once your app is under review, you will have to wait to make any changes and resubmit for review if needed.
Keys to an effective guide
Your start guide should outline the key steps for getting started, and should not just be a link to an external help doc — customers may struggle to use your app effectively if they have to navigate away from the page to get all the information.
The most effective guides:
- Outline the 3-5 steps a user needs to take to start using your app after they have installed it. We suggest focusing on a specific use case and, if your app has additional use cases, listing the others at the bottom of your guide.
- Use concise, action-oriented headlines and number them clearly (e.g., "1. Sign into your Slack account," "2. Create new notification," etc.).
- Keep your description for each step short (2-3 lines max), and use bullet points when possible.
- Include images, GIFs, and screencasts where possible to better explain flows in a visual manner — but no more than one per step.
- Use a button if a step requires a user to navigate to your product or website.
Next Steps
Check out the start guide for the Slack app for some inspiration. You may also use this Start Guide template as a framework.
