In-App Documentation

All your technical documentation available at the click of a button within your own apps and dashboards.

Easy-to-access documentation

Everything you need at the click of a button

All you need in one easy-to-access place

Problem

Going through an app’s documentation is key when learning how it functions and how to best utilize it. The documentation, of course, doesn’t just have to be text but can contain videos, GIFs, and even some interactive options. One thing it does have to be, though, is convenient. A client of ours came to us with this exact dilemma, where they spent too much time back and forth between the app’s documentation and the app itself. This is what the industry standard entails, after all, but it didn’t have to be that way. So, we put our thinking caps on and offered them a solution.

Solution

The solution itself was pretty obvious. If they spent too much time switching between systems or software, then why not just combine the documentation within the app? With a bit of coding, our developers managed to do just that and incorporate not only the text of the technical documentation but also various images, definition tables, and even videos. All of this was available at the click of a button and could be incorporated into any app, sheet, or dashboard.

Success

In the end, our client had a way to train new users without too much hassle. Our solution also helped save them time in the long run since there was no software juggling, just all the info they’d need in one easy-to-access place. This project later evolved into the Guided Tours solution, which you can read more about in this same Good Practices section of the B EYE website.