Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Creating a guide for application developers and administrators

Updated on May 31, 2022

Create an application guide to direct users through a set of tasks. By providing instructional information, you can help users learn about the functionality that your application provides, configure complex settings, or extend features with limited assistance.

Before you begin: Create a rule in the Application DefinitionApplication Guide rule category. For more information, see Creating rules.

You add structure to an application guide by organizing related tasks into chapters. Each task can include instructional text and a link to supporting information, such as an external document or a landing page.

For example, you can create an application guide for migrating locally stored information to a database server. In the chapter for configuring your database, you can add tasks for creating tables, views, and users. In the task for creating users, you can supplement the instructions with a document that lists database privileges.

  1. Adding a chapter to an application guide

    To organize related tasks, add a chapter to an application guide.

  2. Adding a task to a chapter in an application guide

    To provide step-by-step information in an application guide, add a task to a chapter.

  3. Adding supporting information to an application guide

    Add supporting information to an application guide to direct users to the resources that relate to their current task.

  4. Adding an application guide to a portal

    Add your application guide to one or more portals so that users can access it.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us