Online Help: CONTACT´s New Documentation Portal

Even the best IT strategy for supporting business processes cannot be fully effective unless the adopted solutions are prepared and used optimally. In this context, it is important to have a good online help system in which users, system administrators and also service partners can find information relevant to their respective tasks quickly and easily. We have now redesigned our documentation portal to respond to these needs.

The CONTACT Elements technology platform and the products that are built on it, such as CIM DATABASE PLM or Project Office cover many of the applications involved in the innovation process. When used correctly, these solutions bring long-lasting improvements to any company's productivity and value added.

Even though training on the introduction of a new system, an update, or the integration of new modules ensures the necessary level of knowledge, questions never fail to arise during live operation: How can I search with wildcards in Enterprise Search? How do I define a predecessor/successor relationship in a schedule? How do I set up an edge server? How can I define special permissions in the permissions system? …

To provide users, system administrators and also partners with the required information easily, quickly and accurately, we have redesigned our documentation portal and improved the user experience. We briefly present the main innovations in the CONTACT documentation portal below.

Simple navigation
Extensive documentation often has the disadvantage that the content relevant in any given situation may be difficult or even impossible to track down. By contrast, in the new CONTACT documentation portal, the different user groups can start their searches directly in the category that is of interest to them. In addition, it is also possible to jump to other subject areas or back to the start page with a single click wherever you are in the system.

Each category lists all the associated manuals together with a short information text in order to give users a rapid overview of the entire range of topics available in the subject area they have chosen. However, they can also search for specific information.

The new documentation portal has been tailored to meet the needs of different user groups.

Simple navigation
Extensive documentation often has the disadvantage that the content relevant in any given situation may be difficult or even impossible to track down. By contrast, in the new CONTACT documentation portal, the different user groups can start their searches directly in the category that is of interest to them. In addition, it is also possible to jump to other subject areas or back to the start page with a single click wherever you are in the system.

Each category lists all the associated manuals together with a short information text in order to give users a rapid overview of the entire range of topics available in the subject area they have chosen. However, they can also search for specific information.

Global searches
If a user, administrator or partner visits the documentation portal with a specific question that needs resolving, the new search options will take them quickly to the content they require. What is more, the search can be run in the entire documentation base or just in the individual categories.

By skillfully combining the search terms, it is possible to obtain very precise results that provide users with all the information they need in any specific case.

The presentation of the search results has also been optimized. They are now grouped on the basis of category and manual title and are displayed in the form of extended text extracts around the search term, which is itself highlighted in yellow. This makes it easy to identify the search results that are most relevant to the specific problem.

Global searches show results with information on the category and topic.

Global searches
If a user, administrator or partner visits the documentation portal with a specific question that needs resolving, the new search options will take them quickly to the content they require. What is more, the search can be run in the entire documentation base or just in the individual categories.

By skillfully combining the search terms, it is possible to obtain very precise results that provide users with all the information they need in any specific case.

The presentation of the search results has also been optimized. They are now grouped on the basis of category and manual title and are displayed in the form of extended text extracts around the search term, which is itself highlighted in yellow. This makes it easy to identify the search results that are most relevant to the specific problem.

Responsive design, also for smartphones and tablets
The new start page and the presentation of the hit lists clearly show just what has been achieved in terms of look and feel. What cannot be seen at first glance is that the new documentation portal now also reacts "responsively", that is to say it adapts to the respective end device. As a result, users can even make optimum use of the online help system from their smartphones or tablets.

Summary
Software is becoming ever more important for value added in business processes. The new documentation portal simplifies targeted access to product documentation. Whether you are a user, analyst, administrator or developer: Everyone has quick and easy access to the information they need in order to get the very best out of their software.  

The new documentation portal with the functionality presented here will become available in 2017 with the forthcoming versions of CIM DATABASE PLM, Project Office and the CONTACT Elements technology platform.

Output on a smartphone

Responsive design, also for smartphones and tablets
The new start page and the presentation of the hit lists clearly show just what has been achieved in terms of look and feel. What cannot be seen at first glance is that the new documentation portal now also reacts "responsively", that is to say it adapts to the respective end device. As a result, users can even make optimum use of the online help system from their smartphones or tablets.

Summary
Software is becoming ever more important for value added in business processes. The new documentation portal simplifies targeted access to product documentation. Whether you are a user, analyst, administrator or developer: Everyone has quick and easy access to the information they need in order to get the very best out of their software.  

The new documentation portal with the functionality presented here will become available in 2017 with the forthcoming versions of CIM DATABASE PLM, Project Office and the CONTACT Elements technology platform.

 

We are here to help!
Talk with our team:




Locations