Building a Better Help Experience

When designing our new Web User Interface (Web UI), one of our top priorities is to deliver an experience that is not only user-friendly but also highly supportive, intuitive, and informative. Our vision is clear: to create a guided UI experience, backed by a modern, scalable help system that empowers users to understand, configure, and fully utilize the capabilities of our product.

In this post, we’ll walk you through the key principles, features, and innovations in our new Help System—an essential part of enhancing our product usability and customer success.

Why We Reimagined the Help System

In our desktop client interface, in-app help and guidance might often be limited, fragmented, or inconsistent. We knew our new Web UI needed to do better.

Our goals were to:

• Provide clear, contextual support wherever this is needed across the interface

• Deliver comprehensive documentation covering product capabilities and configuration

• Help users quickly find relevant information and reach their goals faster

• Ensure consistency and accessibility in help content throughout the platform

To achieve these goals, we implemented a modern Content Management System (CMS) designed specifically for managing our help documentation. This allowed us to restructure, standardize, and seamlessly integrate all help content within the new Web UI.

What’s New in the Help System

Our redesigned Help System introduces powerful features to improve user onboarding, support, and overall product experience.

📚 Structured, Modular Content

We completely overhauled and reorganized our help documentation, making it:

• Divided into clearly structured chapters

• Covering both general topics (e.g., network scanning, cloud discovery) and feature-specific UI guidance

• Built with modular and reusable components, allowing consistent messaging across the platform

• Fully mapped to every part of the UI, including pages, dialogs, and individual input fields

This detailed structure ensures that help content is always relevant, context-aware, and readily accessible—whether a user is configuring a scan or interpreting report results.

🎯 Contextual Help Throughout the UI

Help content is now embedded directly into the UI, using our standardized help icon, and appears where and when users need it. This includes:

• Input fields – offering quick tooltips and mini-guides

• Pages and dialogs – providing full-text help on features and interactions

• Reports – explaining report concept, as well as columns and fields meaning

• Dashboard items – clarifying UI purposes

• Main Help Section – a centralized knowledge base, structured by topic

Depending on context, help appears as a tooltip or opens in a draggable, resizable help dialog for longer explanations. These dialogs support:

• Internal linking between help topics for deeper navigation

• External links that open in new tabs for additional information or actions

🔍 Smarter Search Capabilities

A core enhancement of the new system is our robust help search functionality, that we designed to support users in finding answers fast.

General Help Search

Every help page includes a search widget that performs full-text searches across the entire help database. Users can explore documentation, discover relevant pages, and dive into the content that fits most.

Page-Specific and Section-Based Search

In high-priority areas—such as the Configuration section—we implemented context-specific help search. This connects search results not only to help pages but also to relevant application locations. This way, users can:

• Read related help documentation

• Follow links to the exact part of the Web UI where they can act on the information

This bridges the gap between knowledge and action—making in-app support both informative and actionable.

What’s Next?

We’re excited about how far we’ve come, but even more excited about what’s ahead. Some upcoming improvements we’re exploring include:

      🔍 Expanding contextual search to even more areas of the application

      🌐 Implementing a global search feature to enable intelligent redirection across the product

      🤖 Integrating AI-driven support to offer real-time, context-aware guidance

These future steps aim to make the Help System even more powerful, dynamic, and user-centered—empowering every user to get the most out of the platform, no matter their experience level.

Final Thoughts

Creating an exceptional product isn’t just about delivering features—it’s also about ensuring users have the right support at the right moment. We built our new Help System to do exactly that: to help users explore, understand, and succeed within the new Web UI.

Stay tuned for more updates—and as always, your feedback is welcome as we continue to refine and improve user experience in our product.