Help content configuration

Edit online

You can access product help content both online and offline. To view the help content online, see IBM Documentation. To view it offline, you can download the content package and deploy the IBM® Documentation Offline application on your computer. Or, an administrator can download the content package and deploy the IBM Documentation on a server on your network.

Types of help configuration
Selecting a configuration

Note: The KCCI is no longer supported. For information on how to view the help content offline, see IBM Documentation Offline.

Types of help configuration

Consider the following configuration options and select one that meets the needs of your organization.

Table 1. Help content configurations
Setup type	Description
IBM Documentation	This configuration is the default selection. No additional setup is needed. An internet connection is required. You can access content directly from the public IBM Documentation. Content is always the current version.
IBM Documentation Offline	IBM Documentation Offline application must be installed to access the product documentation offline. To download and install the IBM Documentation Offline application, see IBM Documentation Offline. To download the content package from the content collection in IBM Documentation, use the Offline docs download link at the end of the table of contents panel. The download link is visible only if you are logged in to IBM Documentation. Upload the content to the IBM Documentation Offline desktop application. An internet connection is not needed. For more information, see Installing IBM Documentation Offline application on your computer.
IBM Documentation Offline on intranet	An intranet server is required. The IBM Documentation Offline intranet version is based on the Node JS framework, which must be installed and configured on Node JS version 16 or later. Set up and configure the IBM Documentation Offline intranet server. For more information, see How to install the IBM Documentation Offline intranet server for use with IBM Engineering Lifecycle Management.

Selecting a configuration

Review the following list of considerations before selecting a help configuration.

Table 2. Selecting a configuration
Consideration	IBM Documentation	IBM Documentation Offline	IBM Documentation Offline on intranet
To configure the help, an internet connection is needed.	Yes	Yes	Yes
To view the help, an internet connection is needed.	Yes	No	No
The configuration is appropriate for an environment with limited internet access.	No	Yes	Yes
An administrator must install the help and configure the web application to access the help.	No	No	Yes
Users must install the help and set a new help connection.	No	Yes	No