Generate In-app Help header image
documentation

Generate In-app Help

If your team makes apps, you can provide a great experience for users by giving them access to the information they need right within your user interface.

template-menu.png

 There are a few different options for creating in-app help, depending on how your app provides access to your help documentation.

Embed Online Help Center Content into Your App

Scroll Viewport is a Confluence app that enables your team to deliver their documentation as a custom help center. Scroll Viewport also makes it possible to give users instant access to online content right from your app. In Scroll Viewport, you can get unique URLs to embed as buttons or links within your app. These links are always up to date, even as you publish newer versions of your documentation. The combination of your app's user interface and your online help documentation provides a seamless information exchange to your users.

For example:

If a user is on the "Create an Account" screen in your app and taps the "Help" button you've added, a dialog box appears with a visually simplified snippet of the "Creating an Account" page from your help center. They can browse the content to find a solution and then quickly close the dialog to continue within your app.

UNKNOWN ATTACHMENT

Learn more about Scroll Viewport.

Embed Offline Help Content into Your App

If your app has offline in-app help, you can use Scroll Exporters to bring your Confluence Server content directly into your user experience. With Scroll exporters for Confluence Server, you can export your documentation in the following formats:

  • Microsoft Compiled HTML Help

  • DocBook

  • EclipseHelp

Embed comments

Next Up...

The simplest ways to share your documentation online involves making some of your Confluence content readable online.

documentation
Steffen Burzlaff Steffen Burzlaff

To make your documentation accessible and useful to your readers, you can turn your Confluence space(s) into an online help center or knowledge base.

documentation
Steffen Burzlaff Steffen Burzlaff

Sometimes a good old document is just what your readers need.

documentation
Steffen Burzlaff Steffen Burzlaff
documentation
Create Documents

Want to host your documentation on your own web server? Export it as an HTML site.

documentation
Steffen Burzlaff Steffen Burzlaff
documentation
Export an HTML Site
Share this article
Reset Cookies

The following services will be reset and deactivated for you.

  • Typeform:
    We're using Typeform to embed quizzes and surveys into our website. By clicking "Disable all services" you're no longer able to submit quizzes or surveys on our website until accepting the service again.
  • Hyvor Talk:
    We're using Hyvor Talk as a comment tool. Hyvor Talk sets a local storage when activated. By clicking "Disable all services" you're no longer able to post or read comments on our website until accepting the service again.

By clicking "Disable all services" all cookies and local storages related to the services will be removed. Before using them on our website again, you need to accept them.