How it Works
With in-app help, you can bring your help content directly into the context of your apps without forcing users to navigate to your help center. By adding a query in the URL of a help page, you can display a simplified view of your help center that's focused on the most important thing, the content. If you call a help article with
inAppHelp query in the URL, it will look something like this:
These page attributes aren't displayed when the
inAppHelp query is used:
Also, links within the page are opened in a new tab.
Add Help in Your App
Implement a help article within your app using the
Implement an iframe within your app at the position your help article should be shown
Go to your help article in the viewport and pick the article you want to display
Copy the Url of the article and add the query "inAppHelp" to the URL
The URL should look something like this: https://k15t.scrollhelp.site/scroll-viewport/Get-Started.843515389.html?inAppHelp=true
Use this URL as the source for the iframe.
Break Up Long Articles with Page Inclusion
It may be the case that your help articles contain information related to more than one area in your app. If your user opens the in-app help, they probably want help for the specific area of the app, and not general information. You can achieve this by separating the content into separate pages in Confluence.
In our help center we have an article with the title "Get started" which describes the onboarding process which contains 5 onboarding steps.
In our UI the onboarding process is a step-by-step wizard. Steps 1-5.
Here is what we need to do in our help center first:
Create 5 new article pages, one for each onboarding step.
On your "Get Started" page, use Include Page macro to include the 5 articles.
Now we could already implement our in-app help feature for the 5 onboarding steps in the UI and match them with our 5 new articles.
However, in our help center navigation we would now find the original "Get Started" article with all onboarding-steps on one page in addition to the 5 new articles. To avoid this unnecessary duplication of content, we will need to add an exclude label to the 5 new articles:
Adding this label will exclude these articles from the navigation and search on your site. Those articles are still live and can be visited from the web, but the pages are hidden within the help center itself.